From 98cdb51424a435d770b8a590888ff5927439fffa Mon Sep 17 00:00:00 2001 From: Mark Wallace <127216156+markwallace-microsoft@users.noreply.github.com> Date: Mon, 1 Sep 2025 18:30:11 +0100 Subject: [PATCH] Move package installation instructions to user-guide (#572) * Move package installation instructions to user-guide * Update user-documentation-dotnet/getting-started/README.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update docs/docs-templates/getting-started/README.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- docs/docs-templates/getting-started/README.md | 54 +++++++++++++++++++ .../getting-started/README.md | 54 +++++++++++++++++++ 2 files changed, 108 insertions(+) diff --git a/docs/docs-templates/getting-started/README.md b/docs/docs-templates/getting-started/README.md index 3205e5e423..e3a5c65382 100644 --- a/docs/docs-templates/getting-started/README.md +++ b/docs/docs-templates/getting-started/README.md @@ -40,6 +40,60 @@ Console.WriteLine(await agent.RunAsync("Tell me a joke about a pirate.")); For more details and more advanced scenarios, see [Getting Started Steps](../../../dotnet/samples/GettingStartedSteps/). +## (Optional) Installing Packages + +Packages will be published to [NuGet](https://www.nuget.org/) when the Agent Framework public preview is released. +In the meantime 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: + ::: zone-end ::: zone pivot="programming-language-python" diff --git a/user-documentation-dotnet/getting-started/README.md b/user-documentation-dotnet/getting-started/README.md index 9b261f3aa8..09f8470ec9 100644 --- a/user-documentation-dotnet/getting-started/README.md +++ b/user-documentation-dotnet/getting-started/README.md @@ -38,4 +38,58 @@ Console.WriteLine(await agent.RunAsync("Tell me a joke about a pirate.")); For more details and more advanced scenarios, see [Getting Started Steps](../../../dotnet/samples/GettingStartedSteps/). +## (Optional) Installing Packages + +Packages will be published to [NuGet](https://www.nuget.org/) when the Agent Framework public preview is released. +In the meantime 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: +