copilot-sdk
Multi-platform SDK for integrating GitHub Copilot Agent into apps and services
Unlock Copilot SDK capabilities by mastering plugin directories and custom agent types. Extend runtime features and build isolated sub-agents for advanced fleet mode execution.
Session Foreground/Background State Management in the Copilot SDKMaster Copilot SDK foreground background state management. Learn to use session IDs and lifecycle events for seamless TUI+server mode synchronization. Get the code now.
Copilot SDK Skills and skillDirectories Configuration: A Complete GuideMaster Copilot SDK skills and skillDirectories configuration. Learn to manage prompt modules, enable/disable skills, and optimize your Copilot experience with this complete guide.
How to Elicit User Input During Agent Execution in the Copilot SDKLearn how to elicit user input during agent execution with the Copilot SDK. Use the Session class and UI helpers like ui.input and ui.confirm for seamless interaction.
Copilot SDK Error Handling and Recovery with the onErrorOccurred HookLearn Copilot SDK error handling and recovery with the onErrorOccurred hook. Intercept failures, control retries, skips, or aborts, and manage notifications for smoother extensions.
Understanding Copilot SDK Factory Limits: maxConcurrentSubagents, timeoutSeconds, and maxAiCreditsLearn about Copilot SDK Factory limits including maxConcurrentSubagents, timeoutSeconds, and maxAiCredits. Prevent runtime overconsumption by understanding these key constraints.
Copilot SDK Agent Stop Hooks and Graceful Shutdown Handling: Implementation GuideLearn how to implement Copilot SDK agent stop hooks and graceful shutdown handling. Run cleanup logic and request follow-up turns before your agent session idles or shuts down.
How to Define Custom Tools Using the `defineTool` API in the Copilot SDKLearn to define custom tools with the Copilot SDK's defineTool API. Register custom functionality and integrate it seamlessly with client.createSession for enhanced capabilities.
Copilot SDK Cloud Sessions and Remote Session Management: The Complete Developer GuideMaster Copilot SDK cloud sessions and remote session management. Explore 'off', 'export', and 'on' modes to control event streaming and real-time steering for seamless development.
Implementing Prompt Enrichment in Copilot SDK: onSessionStart and onUserPromptSubmitted HooksLearn to implement prompt enrichment in Copilot SDK using onSessionStart and onUserPromptSubmitted hooks. Enhance prompts at session start or intercept user messages for better AI responses.
Container Deployment of Copilot SDK with Kubernetes and Persistent Storage: A Complete GuideDeploy the GitHub Copilot SDK on Kubernetes with persistent storage. Implement SessionFSProvider and use PVCs to ensure session data survives pod restarts. Get the complete guide.
How to Stream Session Events and Track Sub-Agent Lifecycle in the Copilot SDKLearn to stream session events and track sub-agent lifecycle in the Copilot SDK. Register an event handler to monitor sub-agent states like start, progress, and termination.
Have a question about this repo?
These articles cover the highlights, but your codebase questions are specific. Give your agent direct access to the source. Share this with your agent to get started:
curl -s "https://instagit.com/install.md" Maintain an open-source project? Get it listed too →