diff --git a/README.md b/README.md index cf437522..3b005c65 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,12 @@ -# Copilot CLI SDKs +# GitHub Copilot CLI SDKs -Language-specific SDKs for programmatic access to the GitHub Copilot CLI. +![GitHub Copilot SDK](./assets/RepoHeader_01.png) -All SDKs are in technical preview and may change in breaking ways as we move towards a stable release. +Agents for every app. + +Embed Copilot's agentic workflows in your application—now available in Technical preview as a programmable SDK for Python, TypeScript, Go, and .NET. + +The GitHub Copilot SDK exposes the same engine behind Copilot CLI: a production-tested agent runtime you can invoke programmatically. No need to build your own orchestration—you define agent behavior, Copilot handles planning, tool invocation, file edits, and more. ## Available SDKs @@ -39,6 +43,10 @@ Your Application The SDK manages the CLI process lifecycle automatically. You can also connect to an external CLI server—see individual SDK docs for details. +## Examples + +Check out the [examples folder](./examples/README.md) for sample projects and videos. + ## Contributing See [CONTRIBUTING.md](./CONTRIBUTING.md) for contribution guidelines. diff --git a/assets/RepoHeader_01.png b/assets/RepoHeader_01.png new file mode 100644 index 00000000..ec4185d6 Binary files /dev/null and b/assets/RepoHeader_01.png differ diff --git a/demos/README.md b/demos/README.md new file mode 100644 index 00000000..4233de2b --- /dev/null +++ b/demos/README.md @@ -0,0 +1,26 @@ +# Demos & Examples + +## Sample Projects + +Explore complete sample projects and tutorials at **[copilot-sdk-samples.coreai.diy](https://copilot-sdk-samples.coreai.diy/)**. + +Quick start examples are also included with each SDK: + +| SDK | In-Repo Examples | +|-----|------------------| +| Node.js | [`nodejs/examples/`](../nodejs/examples/) | +| Python | [`python/`](../python/) | +| Go | [`go/`](../go/) | +| .NET | [`dotnet/`](../dotnet/) | + +## Videos + +| Title | Description | Link | +|-------|-------------|------| +| | | | + + + +## Contributing + +Have a demo or sample to share? Open a PR to add it to this list. diff --git a/examples/README.md b/examples/README.md new file mode 100644 index 00000000..4fc9d6ab --- /dev/null +++ b/examples/README.md @@ -0,0 +1,26 @@ +# Examples + +## Sample Projects + +Explore complete sample projects and tutorials at **[copilot-sdk-samples.coreai.diy](https://copilot-sdk-samples.coreai.diy/)**. + +Quick start examples are also included with each SDK: + +| SDK | In-Repo Examples | +|-----|------------------| +| Node.js | [`nodejs/examples/`](../nodejs/examples/) | +| Python | [`python/`](../python/) | +| Go | [`go/`](../go/) | +| .NET | [`dotnet/`](../dotnet/) | + +## Videos + +| Title | Description | Link | +|-------|-------------|------| +| | | | + + + +## Contributing + +Have a demo or sample to share? Open a PR to add it to this list.