Skip to content

Commit 5cc7e1d

Browse files
krukowCopilot
krukow
and
Copilot
committed
docs: refresh documentation for v0.2.1 public preview
- getting-started.md: add public preview note, fix Clojure version (1.12+), use actual Maven version and git SHA, add missing require - index.md: update example count (17 → 19) - API.md: add missing tool.execution_start data fields (arguments, parent-tool-call-id), remove internal :env-value-mode from config table - examples/README.md: fix run-all-examples.sh count (14 → 16), clarify elicitation handler single-arg ElicitationContext pattern - Regenerate Codox HTML Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 85e36dc commit 5cc7e1d

12 files changed

Lines changed: 481 additions & 35 deletions

‎doc/api/API.html‎

Lines changed: 368 additions & 11 deletions
Large diffs are not rendered by default.

‎doc/api/getting-started.html‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
<!DOCTYPE html PUBLIC ""
22
"">
33
<html><head><meta charset="UTF-8" /><title>Getting Started with the Copilot SDK for Clojure</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name"></span> <span class="project-version"></span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 "><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Topics</span></h3><ul><li class="depth-1 "><a href="API.html"><div class="inner"><span>API Reference</span></div></a></li><li class="depth-1 "><a href="azure-managed-identity.html"><div class="inner"><span>Azure Managed Identity with BYOK</span></div></a></li><li class="depth-1 "><a href="byok.html"><div class="inner"><span>BYOK (Bring Your Own Key)</span></div></a></li><li class="depth-1 "><a href="custom-agents.html"><div class="inner"><span>Custom Agents &amp; Sub-Agent Orchestration</span></div></a></li><li class="depth-1 "><a href="debugging.html"><div class="inner"><span>MCP Server Debugging Guide</span></div></a></li><li class="depth-1 current"><a href="getting-started.html"><div class="inner"><span>Getting Started with the Copilot SDK for Clojure</span></div></a></li><li class="depth-1 "><a href="index.html"><div class="inner"><span>Authentication</span></div></a></li><li class="depth-1 "><a href="index.html"><div class="inner"><span>Documentation</span></div></a></li><li class="depth-1 "><a href="overview.html"><div class="inner"><span>Using MCP Servers with the Copilot SDK for Clojure</span></div></a></li><li class="depth-1 "><a href="style.html"><div class="inner"><span>Documentation Style Guide</span></div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>github</span></div></div></li><li class="depth-2"><a href="github.copilot-sdk.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>copilot-sdk</span></div></a></li><li class="depth-3 branch"><a href="github.copilot-sdk.client.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>client</span></div></a></li><li class="depth-3 branch"><a href="github.copilot-sdk.helpers.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>helpers</span></div></a></li><li class="depth-3 branch"><a href="github.copilot-sdk.instrument.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>instrument</span></div></a></li><li class="depth-3 branch"><a href="github.copilot-sdk.logging.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>logging</span></div></a></li><li class="depth-3 branch"><a href="github.copilot-sdk.process.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>process</span></div></a></li><li class="depth-3 branch"><a href="github.copilot-sdk.protocol.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>protocol</span></div></a></li><li class="depth-3 branch"><a href="github.copilot-sdk.session.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>session</span></div></a></li><li class="depth-3 branch"><a href="github.copilot-sdk.specs.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>specs</span></div></a></li><li class="depth-3 branch"><a href="github.copilot-sdk.tools.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>tools</span></div></a></li><li class="depth-3"><a href="github.copilot-sdk.util.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>util</span></div></a></li></ul></div><div class="document" id="content"><div class="doc"><div class="markdown"><h1><a href="#getting-started-with-the-copilot-sdk-for-clojure" id="getting-started-with-the-copilot-sdk-for-clojure"></a>Getting Started with the Copilot SDK for Clojure</h1>
4+
<blockquote>
5+
<p><strong>Note:</strong> This SDK is in <a href="https://github.blog/changelog/2026-04-02-copilot-sdk-in-public-preview/">public preview</a> and may change in breaking ways.</p>
6+
</blockquote>
47
<p>In this tutorial, you’ll use the Copilot SDK for Clojure to build a command-line assistant. You’ll start with the basics, add streaming responses, then add custom tools — giving Copilot the ability to call your code.</p>
58
<p><strong>What you’ll build:</strong></p>
69
<pre><code>Q: What's the weather like in Seattle?
@@ -14,20 +17,20 @@ <h2><a href="#prerequisites" id="prerequisites"></a>Prerequisites</h2>
1417
<p>Before you begin, make sure you have:</p>
1518
<ul>
1619
<li><strong>GitHub Copilot CLI</strong> installed and authenticated (<a href="https://docs.github.com/en/copilot/how-tos/set-up/install-copilot-cli">Installation guide</a>)</li>
17-
<li><strong>Clojure</strong> 1.11+ with the <code>clojure</code> CLI tool</li>
20+
<li><strong>Clojure</strong> 1.12+ with the <code>clojure</code> CLI tool</li>
1821
<li><strong>Java</strong> 11+</li>
1922
</ul>
2023
<p>Verify the CLI is working:</p>
2124
<pre><code class="language-bash">copilot --version
2225
</code></pre>
2326
<h2><a href="#step-1-add-the-sdk-dependency" id="step-1-add-the-sdk-dependency"></a>Step 1: Add the SDK Dependency</h2>
2427
<p>Add to your <code>deps.edn</code>:</p>
25-
<pre><code class="language-clojure">{:deps {io.github.copilot-community-sdk/copilot-sdk-clojure {:mvn/version "LATEST"}}}
28+
<pre><code class="language-clojure">{:deps {io.github.copilot-community-sdk/copilot-sdk-clojure {:mvn/version "0.2.1.1-SNAPSHOT"}}}
2629
</code></pre>
2730
<p>Or use as a Git dependency:</p>
2831
<pre><code class="language-clojure">{:deps {io.github.copilot-community-sdk/copilot-sdk-clojure
2932
{:git/url "https://github.com/copilot-community-sdk/copilot-sdk-clojure"
30-
:git/sha "LATEST_SHA"}}}
33+
:git/sha "7a30402b9bd843494752c46a18ff7f2fec27a620"}}}
3134
</code></pre>
3235
<h2><a href="#step-2-send-your-first-message" id="step-2-send-your-first-message"></a>Step 2: Send Your First Message</h2>
3336
<p>The simplest way to use the SDK — about 3 lines of code:</p>
@@ -52,7 +55,8 @@ <h2><a href="#step-2-send-your-first-message" id="step-2-send-your-first-message
5255
<h2><a href="#step-3-add-streaming-responses" id="step-3-add-streaming-responses"></a>Step 3: Add Streaming Responses</h2>
5356
<p>Right now, you wait for the complete response before seeing anything. Let’s make it interactive by streaming the response as it’s generated.</p>
5457
<h3><a href="#using-lazy-sequences" id="using-lazy-sequences"></a>Using Lazy Sequences</h3>
55-
<pre><code class="language-clojure">(require '[github.copilot-sdk.helpers :as h])
58+
<pre><code class="language-clojure">(require '[github.copilot-sdk :as copilot])
59+
(require '[github.copilot-sdk.helpers :as h])
5660

5761
(defmulti handle-event :type)
5862
(defmethod handle-event :default [_] nil)

‎doc/api/github.copilot-sdk.client.html‎

Lines changed: 7 additions & 3 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)