github/copilot-sdk

모든 앱을 위한 에이전트 (Agents).

Python, TypeScript, Go, .NET, Java, Rust용 GitHub Copilot SDK를 사용하여 Copilot의 에이전트 워크플로 (agentic workflows)를 애플리케이션에 내장하세요.

GitHub Copilot SDK는 Copilot CLI의 배후에 있는 것과 동일한 엔진, 즉 프로그래밍 방식으로 호출할 수 있는 프로덕션 검증을 마친 에이전트 런타임 (agent runtime)을 제공합니다. 자체적인 오케스트레이션 (orchestration)을 구축할 필요가 없습니다. 사용자는 에이전트의 동작을 정의하기만 하면 되며, Copilot이 계획 수립 (planning), 도구 호출 (tool invocation), 파일 편집 (file edits) 등을 처리합니다.

SDK	위치	쿡북 (Cookbook)	설치 (Installation)
Node.js / TypeScript	nodejs/	Cookbook	npm install @github/copilot-sdk
Python	python/	Cookbook	pip install github-copilot-sdk
Go	go/	Cookbook	go get github.com/github/copilot-sdk/go
.NET	dotnet/	Cookbook	dotnet add package GitHub.Copilot.SDK
Rust	rust/	—	cargo add github-copilot-sdk
Java	java/	Cookbook	Maven 좌표 com.github:copilot-sdk-java Maven 및 Gradle에 대한 지침 참조

설치, 사용 예시 및 API 참조를 보려면 각 SDK의 README를 확인하세요.

전체 과정을 살펴보려면 **시작 가이드 (Getting Started Guide)**를 참조하세요.

빠른 단계:

(선택 사항) Copilot CLI 설치

Node.js, Python, .NET SDK의 경우 Copilot CLI가 자동으로 번들링되어 별도의 설치가 필요하지 않습니다.
Go, Java, Rust의 경우 CLI를 수동으로 설치하거나 copilot이 PATH에서 사용 가능한지 확인하세요. Go와 Rust는 애플리케이션 수준의 CLI 번들링 기능도 제공합니다.

• 위 명령어를 사용하여 선호하는 SDK를 설치하세요.
• 사용 예시 및 API 문서를 보려면 SDK README를 확인하세요.

모든 SDK는 JSON-RPC를 통해 Copilot CLI 서버와 통신합니다:

사용자 애플리케이션 (Your Application)
↓
SDK 클라이언트 (SDK Client)
...

SDK는 CLI 프로세스의 생명주기 (lifecycle)를 자동으로 관리합니다. 또한 외부 CLI 서버에 연결할 수도 있습니다. CLI를 서버 모드로 실행하는 데 대한 자세한 내용은 시작 가이드를 참조하세요.

네, BYOK (Bring Your Own Key)를 사용하는 경우가 아니라면 GitHub Copilot SDK를 사용하기 위해 GitHub Copilot 구독이 필요합니다. BYOK를 사용하면 지원되는 LLM (Large Language Model) 제공업체의 자체 API 키를 구성하여 GitHub 인증 없이 SDK를 사용할 수 있습니다. 표준 사용 방식 (non-BYOK)의 경우, 사용량이 제한된 무료 티어가 포함된 GitHub Copilot 가격 페이지를 참조하세요.

GitHub Copilot SDK의 과금은 Copilot CLI와 동일한 모델을 기반으로 하며, 각 프롬프트(prompt)는 프리미엄 요청 할당량(premium request quota)에 포함됩니다. 프리미엄 요청에 대한 자세한 내용은 Requests in GitHub Copilot을 참조하세요.

네, GitHub Copilot SDK는 BYOK (Bring Your Own Key)를 지원합니다. 지원되는 LLM 제공업체(예: OpenAI, Azure AI Foundry, Anthropic)의 자체 API 키를 사용하도록 SDK를 구성하여 해당 제공업체를 통해 모델에 액세스할 수 있습니다. 설정 방법 및 예제는 BYOK documentation을 참조하세요.

참고: BYOK는 키 기반 인증(key-based authentication)만 사용합니다. Microsoft Entra ID (Azure AD), 관리 ID(managed identities) 및 제3자 ID 제공업체(third-party identity providers)는 지원되지 않습니다.

SDK는 여러 인증 방법을 지원합니다:

GitHub 로그인 사용자- copilot CLI 로그인에서 저장된 OAuth 자격 증명을 사용합니다.
OAuth GitHub App- GitHub OAuth 앱에서 사용자 토큰을 전달합니다.
환경 변수 (Environment variables)- COPILOT_GITHUB_TOKEN, GH_TOKEN, GITHUB_TOKEN
BYOK- 자체 API 키를 사용합니다 (GitHub 인증 불필요)

각 방법에 대한 자세한 내용은 Authentication documentation을 참조하세요.

아니요 — Node.js, Python 및 .NET SDK의 경우, Copilot CLI가 종속성(dependency)으로 자동 포함됩니다. 별도로 설치할 필요가 없습니다.

Go, Java 및 Rust SDK의 경우, CLI가 기본적으로 포함되지 않습니다. CLI를 수동으로 설치하거나 copilot이 PATH에 있는지 확인하세요. Go와 Rust는 애플리케이션 수준의 CLI 번들링 기능도 제공합니다.

고급: CLI 바이너리를 재정의하거나 외부 서버에 연결할 수 있습니다. 언어별 옵션은 각 SDK의 README를 참조하세요.

기본적으로 SDK는 --allow-all 옵션으로 CLI를 실행하는 것과 유사하게 Copilot CLI의 퍼스트 파티 도구 (first-party tools)를 노출합니다. 도구 실행은 여전히 각 SDK의 권한 핸들러 (permission handler)에 의해 제어되므로, 애플리케이션에서 도구 호출을 승인, 거부 또는 사용자 정의할 수 있습니다. 특정 도구를 활성화하거나 비활성화하도록 SDK 클라이언트 옵션을 구성하여 도구 가용성을 사용자 정의할 수 있습니다. 도구 구성에 대한 자세한 내용은 각 SDK 문서를 참조하고, 사용 가능한 도구 목록은 Copilot CLI 문서를 참조하세요.

네, GitHub Copilot SDK를 사용하면 커스텀 에이전트 (custom agents), 스킬 (skills) 및 도구 (tools)를 정의할 수 있습니다. 자체 로직을 구현하고 필요에 따라 추가 도구를 통합함으로써 에이전트의 기능을 확장할 수 있습니다. 자세한 내용은 선호하는 언어의 SDK 문서를 참조하세요.

네, 커스텀 인스트럭션 (custom instructions) 및 SDK별 가이드를 확인해 보세요:

Copilot CLI를 통해 사용할 수 있는 모든 모델이 SDK에서 지원됩니다. 또한 SDK는 런타임에 접근할 수 있도록 사용 가능한 모델을 반환하는 메서드를 제공합니다.

GitHub Copilot SDK는 일반적으로 사용 가능하며 유의적 버전 (semantic versioning)을 따릅니다. 릴리스 노트는 CHANGELOG.md를 참조하세요.

버그를 보고하거나 새로운 기능을 요청하려면 GitHub Issues 페이지를 사용해 주세요. SDK 개선에 도움이 되는 여러분의 피드백을 환영합니다.

Documentation (문서) – 전체 문서 인덱스
Getting Started (시작하기) – 실행을 위한 튜토리얼
Setup Guides (설정 가이드) – 아키텍처, 배포 및 확장
Authentication (인증) – GitHub OAuth, BYOK 등
Features (기능) – 훅 (Hooks), 커스텀 에이전트, MCP, 스킬 등
Troubleshooting (문제 해결) – 일반적인 문제 및 해결 방법
Cookbook (쿡북) – 모든 언어에 걸친 일반적인 작업에 대한 실용적인 레시피
More Resources (추가 리소스) – 추가 예제, 튜토리얼 및 커뮤니티 리소스

SDK	위치
Clojure	copilot-community-sdk/copilot-sdk-clojure
C++	0xeb/copilot-sdk-cpp

기여 가이드라인은 CONTRIBUTING.md를 참조하세요.

MIT