@nomomon/ai-sdk-provider-github-copilot 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,123 @@
+# AI SDK Provider for GitHub Copilot
+
+Vercel AI SDK community provider for GitHub Copilot - use `streamText`, `generateText`, and related AI SDK APIs with GitHub Copilot as the backend model.
+
+## Installation
+
+### 1. Install and authenticate the Copilot CLI
+
+Follow the [Copilot CLI installation guide](https://github.com/github/copilot-sdk) to install the CLI and ensure `copilot` is available in your PATH.
+
+### 2. Add the provider
+
+```bash
+npm install @nomomon/ai-sdk-provider-github-copilot ai@^6.0.0
+```
+
+## Quick Start
+
+### Non-streaming (generateText)
+
+```typescript
+import { generateText } from "ai";
+import { githubCopilot } from "@nomomon/ai-sdk-provider-github-copilot";
+
+const { text } = await generateText({
+  model: githubCopilot("gpt-5"),
+  prompt: "Hello, Copilot!",
+});
+
+console.log(text);
+```
+
+### Streaming (streamText)
+
+```typescript
+import { streamText } from "ai";
+import { githubCopilot } from "@nomomon/ai-sdk-provider-github-copilot";
+
+const result = streamText({
+  model: githubCopilot("gpt-5"),
+  prompt: "Tell me a short story",
+});
+
+for await (const chunk of result.textStream) {
+  process.stdout.write(chunk);
+}
+```
+
+## Models
+
+Use model IDs available via Copilot CLI, for example:
+
+- `gpt-5` - GPT-5 (when available)
+- `claude-sonnet-4.5` - Claude Sonnet
+- `claude-opus-4` - Claude Opus
+
+Run `copilot models` to list available models in your environment.
+
+## Configuration
+
+### Provider settings
+
+```typescript
+import { githubCopilot } from "@nomomon/ai-sdk-provider-github-copilot";
+
+const model = githubCopilot("gpt-5", {
+  model: "claude-sonnet-4.5", // Override model
+  systemMessage: {
+    content: "You are a helpful assistant specialized in code review.",
+  },
+  workingDirectory: "/path/to/project",
+  provider: {
+    type: "openai",
+    baseUrl: "https://my-api.example.com/v1",
+    apiKey: process.env.MY_API_KEY,
+  },
+});
+```
+
+### Custom tools
+
+Pass tools via provider settings using Copilot's `defineTool`:
+
+```typescript
+import { defineTool } from "@github/copilot-sdk";
+import { z } from "zod";
+import { githubCopilot } from "@nomomon/ai-sdk-provider-github-copilot";
+
+const model = githubCopilot("gpt-5", {
+  tools: [
+    defineTool("lookup_issue", {
+      description: "Fetch issue details from our tracker",
+      parameters: z.object({
+        id: z.string().describe("Issue identifier"),
+      }),
+      handler: async ({ id }) => {
+        return await fetchIssue(id);
+      },
+    }),
+  ],
+});
+```
+
+## Limitations
+
+- **Requires Copilot CLI** - Must be installed and authenticated
+- **Node.js >= 18** - Required runtime
+- **Image inputs** - Copilot uses file path attachments; base64/data URLs may require temp files
+- **Unsupported parameters** - `temperature`, `maxTokens`, `topP`, etc. are not supported by the Copilot CLI and will be ignored (warnings emitted)
+- **Structured outputs** - Native JSON schema support may be limited; consider prompt engineering for structured responses
+- **Session-based** - Each generate/stream creates a new session; no built-in multi-session continuity across separate AI SDK calls
+
+## Disclaimer
+
+**This is an unofficial community provider** and is not affiliated with or endorsed by GitHub or Vercel. By using this provider:
+
+- You understand that your data will be sent to GitHub's servers through the Copilot CLI
+- You agree to comply with GitHub's Terms of Service
+- You acknowledge this software is provided "as is" without warranties of any kind
+
+## License
+
+MIT