diff --git a/docs/FAQS.md b/docs/FAQS.md new file mode 100644 index 0000000000..944b8c09a0 --- /dev/null +++ b/docs/FAQS.md @@ -0,0 +1,54 @@ +# Frequently Asked Questions + +### How do I get access to nightly builds? + +Nightly builds of the Agent Framework are available [here](https://github.com/orgs/microsoft/packages?repo_name=agent-framework). + +To download nightly builds follow the following steps: + +1. You will need a GitHub account to complete these steps. +1. Create a GitHub Personal Access Token with the `read:packages` scope using these [instructions](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-personal-access-token-classic). +1. If your account is part of the Microsoft organization then you must authorize the `Microsoft` organization as a single sign-on organization. + 1. Click the "Configure SSO" next to the Personal Access Token you just created and then authorize `Microsoft`. +1. Use the following command to add the Microsoft GitHub Packages source to your NuGet configuration: + + ```powershell + dotnet nuget add source --username GITHUBUSERNAME --password GITHUBPERSONALACCESSTOKEN --store-password-in-clear-text --name GitHubMicrosoft "https://nuget.pkg.github.com/microsoft/index.json" + ``` + +1. Or you can manually create a `NuGet.Config` file. + + ```xml + + + + + + + + + + + + + + + + + + + + + + + + ``` + + * If you place this file in your project folder make sure to have Git (or whatever source control you use) ignore it. + * For more information on where to store this file go [here](https://learn.microsoft.com/en-us/nuget/reference/nuget-config-file). +1. You can now add packages from the nightly build to your project. + * E.g. use this command `dotnet add package Microsoft.Extensions.AI.Agents --version 0.0.1-nightly-250731.6-alpha` +1. And the latest package release can be referenced in the project like this: + * `` + +For more information see: