아키텍처 개요
모든 Copilot SDK 통합은 동일한 핵심 패턴을 따릅니다. 애플리케이션은 JSON-RPC를 통해 Copilot CLI와 통신하는 SDK와 통신합니다. 설정에서 변경되는 사항은 CLI가 실행되는 위치, 사용자가 인증하는 방법 및 세션 관리 방식입니다.
아래 설정 가이드는 시나리오에 맞게 각 계층을 구성하는 데 도움이 됩니다.
누구시죠?
🧑 💻 아마추어
개인 비서, 사이드 프로젝트 또는 실험적 앱을 빌드하고 있습니다. 코드에서 코필로트를 가져오는 가장 간단한 경로를 원합니다.
다음으로 시작합니다.
- ** 기본 설정(번들 CLI)** - SDK에 CLI가 자동으로 포함되어 있습니다. 설치하고 이동하기만 하면
- ** 로컬 CLI 설정** - 사용자 고유의 CLI 이진 또는 실행 중인 인스턴스 사용(고급)
🏢 내부 앱 개발자
팀 또는 회사를 위한 도구를 빌드하고 있습니다. 사용자는 엔터프라이즈 GitHub 계정 또는 조직 멤버 자격으로 인증해야 하는 직원입니다.
다음으로 시작합니다.
- ** GitHub OAuth 설정** - 직원이 GitHub 계정으로 로그인하도록 허용
- ** 백 엔드 서비스 설정** - 내부 서비스에서 SDK 실행
단일 서버 이상으로 스케일링하는 경우:
- ** 확장성 및 멀티 테넌시** - 여러 사용자 및 서비스 처리
🚀 앱 개발자(ISV)
고객을 위한 제품을 빌드하고 있습니다. GitHub 통해 또는 ID를 직접 관리하여 사용자에 대한 인증을 처리해야 합니다.
다음으로 시작합니다.
- ** GitHub OAuth 설정** - 고객이 GitHub 로그인하도록 허용
- ** BYOK (bring your own key)** - 사용자 고유의 모델 키를 사용하여 ID 직접 관리
- ** 백 엔드 서비스 설정** - 서버 쪽 코드에서 제품 전원 공급
프로덕션의 경우:
- ** 확장성 및 멀티 테넌시** - 많은 고객에게 안정적으로 제공
🏗️ 플랫폼 개발자
다른 개발자가 빌드하는 API, 개발자 도구 또는 인프라와 같은 플랫폼에 Copilot를 포함하고 있습니다. 세션, 크기 조정 및 다중 테넌시에 대한 세분화된 제어가 필요합니다.
다음으로 시작합니다.
- ** 백 엔드 서비스 설정** - 핵심 서버 쪽 통합
- ** 확장성 및 멀티 테넌시** - 세션 격리, 수평 크기 조정, 지속성
인증 모델에 따라:
- ** GitHub OAuth 설정** - GitHub 인증된 사용자의 경우
- ** BYOK (bring your own key)** - 자체 관리 ID 및 모델 액세스의 경우
의사 결정 행렬
다음 표를 사용하여 수행해야 하는 작업을 기반으로 올바른 가이드를 찾을 수 있습니다.
| 필요한 항목 | 가이드 |
|---|---|
| 빠르게 시작 | |
| 기본 설정(번들 CLI) | |
| 자체 CLI 바이너리 또는 서버 사용 | |
| 로컬 CLI 설정 | |
| 사용자가 GitHub 사용하여 로그인 | |
| GitHub OAuth 설정 | |
| 사용자 고유의 모델 키 사용(OpenAI, Azure 등) | |
| BYOK (bring your own key) | |
| 관리 ID를 사용하는 Azure BYOK(API 키 없음) | |
| BYOK를 사용하는 Azure 관리 ID | |
| 서버에서 SDK 실행 | |
| 백 엔드 서비스 설정 | |
| 여러 사용자 제공/수평으로 크기 조정 | |
| 확장성 및 멀티 테넌시 |
구성 비교
사전 요구 사항
모든 안내서는 사용자가 다음 조건을 갖추고 있다고 가정합니다.
- 다음 SDK 중 하나가 설치되어 있어야 합니다(Node.js, Python 및 .NET SDK에는 CLI가 자동으로 포함됨):
- Node.js:
npm install @github/copilot-sdk - 파이썬:
pip install github-copilot-sdk - Go:
go get github.com/github/copilot-sdk/go(별도의 CLI 설치 필요) - .NET:
dotnet add package GitHub.Copilot.SDK
- Node.js:
처음이라면 먼저 첫 번째 Copilot 기반 앱 빌드 부터 시작한 다음, 프로덕션 환경 구성을 위해 여기로 돌아오세요.
다음 단계
위의 의사 결정 매트릭스 에서 상황과 일치하는 가이드를 선택하거나 역할에 가장 가까운 가상 사용자 설명으로 시작합니다.