选择 Copilot SDK 的设置路径

注意

          Copilot SDK 当前处于 技术预览版. 功能和可用性可能会发生更改。

体系结构概述

每个 GitHub Copilot SDK 集成都遵循相同的核心模式：应用程序与 SDK 通信，该 SDK 通过 Copilot CLI JSON-RPC 进行通信。在设置中，CLI 的运行方式、用户身份验证方式以及会话的管理方式等都发生了哪些更改。

你正在构建个人助理、侧项目或实验应用。你希望在代码中使用最简单的方法来获取 Copilot。

          **首先：**

          [AUTOTITLE](/copilot/how-tos/copilot-sdk/set-up-copilot-sdk/local-cli) - 使用已在计算机上登录的 CLI。

       [AUTOTITLE](/copilot/how-tos/copilot-sdk/set-up-copilot-sdk/bundled-cli) - 将所有内容打包到独立应用中。

你正在为团队或公司构建工具。用户是需要使用企业 GitHub 帐户或组织成员身份进行身份验证的员工。

          **首先：**

1. 将 GitHub OAuth 与 Copilot SDK 配合使用 - 让员工使用其 GitHub 帐户登录。 1. 为后端服务设置 Copilot SDK - 在内部服务中运行 SDK。

          **如果扩展超出单个服务器：**

1. 扩展 Copilot SDK 的部署 - 处理多个用户和服务。

你要为客户构建产品。需要处理用户的身份验证，通过 GitHub 或自行管理标识。

          **首先：**

          [BYOK](https://github.com/github/copilot-sdk/blob/main/docs/auth/byok.md) 在 `github/copilot-sdk` 存储库中 - 使用自己的模型密钥管理标识。

       [AUTOTITLE](/copilot/how-tos/copilot-sdk/set-up-copilot-sdk/backend-services) - 通过服务器端代码为产品提供支持。

用于生产：

       [AUTOTITLE](/copilot/how-tos/copilot-sdk/set-up-copilot-sdk/scaling) - 可靠地为许多客户提供服务。

你正在将 Copilot 嵌入到平台（API、开发人员工具或其他开发人员所构建的基础结构）中。你需要对会话、缩放和多租户进行精细控制。

          **首先：**

1. 为后端服务设置 Copilot SDK — 核心服务器端集成。 1. 扩展 Copilot SDK 的部署 — 会话隔离、水平缩放、持久性。

          **根据身份验证模型：**

1. 将 GitHub OAuth 与 Copilot SDK 配合使用 - 适用于 GitHub经过身份验证的用户。

          [BYOK](https://github.com/github/copilot-sdk/blob/main/docs/auth/byok.md) 在 `github/copilot-sdk` 存储库中，用于自托管的标识和模型访问。

使用此表根据需要执行的操作查找正确的指南。

所需内容	指南
最简单的设置

          [AUTOTITLE](/copilot/how-tos/copilot-sdk/set-up-copilot-sdk/local-cli) |

所有指南都假定你有：

        **
        Copilot CLI
        ** 安装。 有关详细信息，请参阅“[AUTOTITLE](/copilot/how-tos/copilot-cli/set-up-copilot-cli/install-copilot-cli)”。

已安装的 SDK 中之一：
- Node.js：npm install @github/copilot-sdk
- Python： pip install github-copilot-sdk
- Go： go get github.com/github/copilot-sdk/go
- .NET：dotnet add package GitHub.Copilot.SDK

如果不熟悉 GitHub Copilot SDK，请先从开始使用 Copilot SDK 开始，然后返回此处进行生产配置。

从上面的决策矩阵中选择与情况匹配的指南，或从最接近角色的角色描述开始。