mirror of
https://github.com/github/awesome-copilot.git
synced 2026-03-23 09:35:13 +00:00
Align Copilot SDK documentation with permission handling requirements (#1107)
* Apply permission handler requirements across Copilot SDK docs Co-authored-by: jamesmontemagno <1676321+jamesmontemagno@users.noreply.github.com> Agent-Logs-Url: https://github.com/jamesmontemagno/awesome-copilot/sessions/adf27a88-92f8-4ca6-b3fe-1204e3bb9963 * Polish permission update formatting in SDK examples Co-authored-by: jamesmontemagno <1676321+jamesmontemagno@users.noreply.github.com> Agent-Logs-Url: https://github.com/jamesmontemagno/awesome-copilot/sessions/adf27a88-92f8-4ca6-b3fe-1204e3bb9963 * Fix review comments on SDK permission handling PR Address 5 review comments from PR #1103: 1. Fix invalid object literal syntax (stray comma) in resumeSession example in copilot-sdk-nodejs.instructions.md 2. Replace unused PermissionHandler import with actual usage in cookbook/copilot-sdk/python/recipe/ralph_loop.py (was using inline lambda instead) 3. Replace unused approveAll import with actual usage in cookbook/copilot-sdk/nodejs/recipe/ralph-loop.ts (was using inline handler instead) 4. Add missing PermissionHandler import to 4 Python code snippets in skills/copilot-sdk/SKILL.md that reference it without importing 5. Add missing approveAll import to 3 TypeScript code snippets in skills/copilot-sdk/SKILL.md that reference it without importing * Refactor session creation to improve code formatting and consistency across SDK examples * Fix formatting: split multi-property lines and put closing braces on own lines Address review comments on PR #1107: - Split OnPermissionRequest + Model onto separate lines in Go, C#, TypeScript - Put closing }); on its own line consistently across all examples - Fix indentation in SKILL.md Quick Start, CLI URL, Error Handling sections - Fix cookbook Go multiple-sessions and error-handling formatting - Fix ralph-loop.md TypeScript indentation --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: jamesmontemagno <1676321+jamesmontemagno@users.noreply.github.com>
This commit is contained in:
@@ -46,7 +46,7 @@ await using var client = new CopilotClient();
|
||||
await client.StartAsync();
|
||||
|
||||
// Resume the previous session
|
||||
var session = await client.ResumeSessionAsync("user-123-conversation");
|
||||
var session = await client.ResumeSessionAsync("user-123-conversation", new ResumeSessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll });
|
||||
|
||||
// Previous context is restored
|
||||
await session.SendAsync(new MessageOptions { Prompt = "What were we discussing?" });
|
||||
|
||||
@@ -22,7 +22,7 @@ await session.DisposeAsync();
|
||||
Console.WriteLine("Session destroyed (state persisted)");
|
||||
|
||||
// Resume the previous session
|
||||
var resumed = await client.ResumeSessionAsync("user-123-conversation");
|
||||
var resumed = await client.ResumeSessionAsync("user-123-conversation", new ResumeSessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll });
|
||||
Console.WriteLine($"Resumed: {resumed.SessionId}");
|
||||
|
||||
await resumed.SendAsync(new MessageOptions { Prompt = "What were we discussing?" });
|
||||
|
||||
@@ -77,6 +77,7 @@ func main() {
|
||||
|
||||
streaming := true
|
||||
session, err := client.CreateSession(ctx, &copilot.SessionConfig{
|
||||
OnPermissionRequest: copilot.PermissionHandler.ApproveAll,
|
||||
Model: "claude-opus-4.6",
|
||||
Streaming: &streaming,
|
||||
McpServers: map[string]interface{}{
|
||||
@@ -214,6 +215,7 @@ The recipe configures a local MCP server that runs alongside the session:
|
||||
|
||||
```go
|
||||
session, err := client.CreateSession(ctx, &copilot.SessionConfig{
|
||||
OnPermissionRequest: copilot.PermissionHandler.ApproveAll,
|
||||
McpServers: map[string]interface{}{
|
||||
"playwright": map[string]interface{}{
|
||||
"type": "local",
|
||||
|
||||
@@ -34,6 +34,7 @@ func main() {
|
||||
defer client.Stop()
|
||||
|
||||
session, err := client.CreateSession(ctx, &copilot.SessionConfig{
|
||||
OnPermissionRequest: copilot.PermissionHandler.ApproveAll,
|
||||
Model: "gpt-5",
|
||||
})
|
||||
if err != nil {
|
||||
@@ -177,7 +178,10 @@ func doWork() error {
|
||||
}
|
||||
defer client.Stop()
|
||||
|
||||
session, err := client.CreateSession(ctx, &copilot.SessionConfig{Model: "gpt-5"})
|
||||
session, err := client.CreateSession(ctx, &copilot.SessionConfig{
|
||||
OnPermissionRequest: copilot.PermissionHandler.ApproveAll,
|
||||
Model: "gpt-5",
|
||||
})
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to create session: %w", err)
|
||||
}
|
||||
|
||||
@@ -38,6 +38,7 @@ func main() {
|
||||
|
||||
// Create session
|
||||
session, err := client.CreateSession(ctx, &copilot.SessionConfig{
|
||||
OnPermissionRequest: copilot.PermissionHandler.ApproveAll,
|
||||
Model: "gpt-5",
|
||||
})
|
||||
if err != nil {
|
||||
|
||||
@@ -34,19 +34,28 @@ func main() {
|
||||
defer client.Stop()
|
||||
|
||||
// Create multiple independent sessions
|
||||
session1, err := client.CreateSession(ctx, &copilot.SessionConfig{Model: "gpt-5"})
|
||||
session1, err := client.CreateSession(ctx, &copilot.SessionConfig{
|
||||
OnPermissionRequest: copilot.PermissionHandler.ApproveAll,
|
||||
Model: "gpt-5",
|
||||
})
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
defer session1.Destroy()
|
||||
|
||||
session2, err := client.CreateSession(ctx, &copilot.SessionConfig{Model: "gpt-5"})
|
||||
session2, err := client.CreateSession(ctx, &copilot.SessionConfig{
|
||||
OnPermissionRequest: copilot.PermissionHandler.ApproveAll,
|
||||
Model: "gpt-5",
|
||||
})
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
defer session2.Destroy()
|
||||
|
||||
session3, err := client.CreateSession(ctx, &copilot.SessionConfig{Model: "claude-sonnet-4.5"})
|
||||
session3, err := client.CreateSession(ctx, &copilot.SessionConfig{
|
||||
OnPermissionRequest: copilot.PermissionHandler.ApproveAll,
|
||||
Model: "claude-sonnet-4.5",
|
||||
})
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
@@ -70,6 +79,7 @@ Use custom IDs for easier tracking:
|
||||
|
||||
```go
|
||||
session, err := client.CreateSession(ctx, &copilot.SessionConfig{
|
||||
OnPermissionRequest: copilot.PermissionHandler.ApproveAll,
|
||||
SessionID: "user-123-chat",
|
||||
Model: "gpt-5",
|
||||
})
|
||||
|
||||
@@ -32,6 +32,7 @@ func main() {
|
||||
|
||||
// Create session with a memorable ID
|
||||
session, _ := client.CreateSession(ctx, &copilot.SessionConfig{
|
||||
OnPermissionRequest: copilot.PermissionHandler.ApproveAll,
|
||||
SessionID: "user-123-conversation",
|
||||
Model: "gpt-5",
|
||||
})
|
||||
@@ -55,7 +56,7 @@ client.Start(ctx)
|
||||
defer client.Stop()
|
||||
|
||||
// Resume the previous session
|
||||
session, _ := client.ResumeSession(ctx, "user-123-conversation")
|
||||
session, _ := client.ResumeSession(ctx, "user-123-conversation", &copilot.ResumeSessionConfig{OnPermissionRequest: copilot.PermissionHandler.ApproveAll})
|
||||
|
||||
// Previous context is restored
|
||||
session.SendAndWait(ctx, copilot.MessageOptions{Prompt: "What were we discussing?"})
|
||||
|
||||
@@ -138,6 +138,7 @@ func main() {
|
||||
|
||||
cwd, _ := os.Getwd()
|
||||
session, err := client.CreateSession(ctx, &copilot.SessionConfig{
|
||||
OnPermissionRequest: copilot.PermissionHandler.ApproveAll,
|
||||
Model: "gpt-5",
|
||||
SystemMessage: &copilot.SystemMessageConfig{
|
||||
Content: fmt.Sprintf(`
|
||||
|
||||
@@ -70,6 +70,7 @@ func ralphLoop(ctx context.Context, promptFile string, maxIterations int) error
|
||||
|
||||
// Fresh session each iteration — context isolation is the point
|
||||
session, err := client.CreateSession(ctx, &copilot.SessionConfig{
|
||||
OnPermissionRequest: copilot.PermissionHandler.ApproveAll,
|
||||
Model: "gpt-5.1-codex-mini",
|
||||
})
|
||||
if err != nil {
|
||||
|
||||
@@ -45,6 +45,7 @@ func main() {
|
||||
|
||||
streaming := true
|
||||
session, err := client.CreateSession(ctx, &copilot.SessionConfig{
|
||||
OnPermissionRequest: copilot.PermissionHandler.ApproveAll,
|
||||
Model: "claude-opus-4.6",
|
||||
Streaming: &streaming,
|
||||
McpServers: map[string]interface{}{
|
||||
|
||||
@@ -18,6 +18,7 @@ func main() {
|
||||
defer client.Stop()
|
||||
|
||||
session, err := client.CreateSession(ctx, &copilot.SessionConfig{
|
||||
OnPermissionRequest: copilot.PermissionHandler.ApproveAll,
|
||||
Model: "gpt-5",
|
||||
})
|
||||
if err != nil {
|
||||
|
||||
@@ -22,6 +22,7 @@ func main() {
|
||||
|
||||
// Create session
|
||||
session, err := client.CreateSession(ctx, &copilot.SessionConfig{
|
||||
OnPermissionRequest: copilot.PermissionHandler.ApproveAll,
|
||||
Model: "gpt-5",
|
||||
})
|
||||
if err != nil {
|
||||
|
||||
@@ -18,19 +18,28 @@ func main() {
|
||||
defer client.Stop()
|
||||
|
||||
// Create multiple independent sessions
|
||||
session1, err := client.CreateSession(ctx, &copilot.SessionConfig{Model: "gpt-5"})
|
||||
session1, err := client.CreateSession(ctx, &copilot.SessionConfig{
|
||||
OnPermissionRequest: copilot.PermissionHandler.ApproveAll,
|
||||
Model: "gpt-5",
|
||||
})
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
defer session1.Destroy()
|
||||
|
||||
session2, err := client.CreateSession(ctx, &copilot.SessionConfig{Model: "gpt-5"})
|
||||
session2, err := client.CreateSession(ctx, &copilot.SessionConfig{
|
||||
OnPermissionRequest: copilot.PermissionHandler.ApproveAll,
|
||||
Model: "gpt-5",
|
||||
})
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
defer session2.Destroy()
|
||||
|
||||
session3, err := client.CreateSession(ctx, &copilot.SessionConfig{Model: "claude-sonnet-4.5"})
|
||||
session3, err := client.CreateSession(ctx, &copilot.SessionConfig{
|
||||
OnPermissionRequest: copilot.PermissionHandler.ApproveAll,
|
||||
Model: "claude-sonnet-4.5",
|
||||
})
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
|
||||
@@ -18,6 +18,7 @@ func main() {
|
||||
|
||||
// Create session with a memorable ID
|
||||
session, err := client.CreateSession(ctx, &copilot.SessionConfig{
|
||||
OnPermissionRequest: copilot.PermissionHandler.ApproveAll,
|
||||
SessionID: "user-123-conversation",
|
||||
Model: "gpt-5",
|
||||
})
|
||||
@@ -36,7 +37,7 @@ func main() {
|
||||
fmt.Println("Session destroyed (state persisted)")
|
||||
|
||||
// Resume the previous session
|
||||
resumed, err := client.ResumeSession(ctx, "user-123-conversation")
|
||||
resumed, err := client.ResumeSession(ctx, "user-123-conversation", &copilot.ResumeSessionConfig{OnPermissionRequest: copilot.PermissionHandler.ApproveAll})
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
|
||||
@@ -102,6 +102,7 @@ func main() {
|
||||
|
||||
cwd, _ := os.Getwd()
|
||||
session, err := client.CreateSession(ctx, &copilot.SessionConfig{
|
||||
OnPermissionRequest: copilot.PermissionHandler.ApproveAll,
|
||||
Model: "gpt-5",
|
||||
SystemMessage: &copilot.SystemMessageConfig{
|
||||
Content: fmt.Sprintf(`
|
||||
|
||||
@@ -35,7 +35,7 @@ npx tsx accessibility-report.ts
|
||||
```typescript
|
||||
#!/usr/bin/env npx tsx
|
||||
|
||||
import { CopilotClient } from "@github/copilot-sdk";
|
||||
import { CopilotClient, approveAll } from "@github/copilot-sdk";
|
||||
import * as readline from "node:readline";
|
||||
|
||||
// ============================================================================
|
||||
@@ -73,6 +73,7 @@ async function main() {
|
||||
const client = new CopilotClient();
|
||||
|
||||
const session = await client.createSession({
|
||||
onPermissionRequest: approveAll,
|
||||
model: "claude-opus-4.6",
|
||||
streaming: true,
|
||||
mcpServers: {
|
||||
@@ -191,6 +192,7 @@ The recipe configures a local MCP server that runs alongside the session:
|
||||
|
||||
```typescript
|
||||
const session = await client.createSession({
|
||||
onPermissionRequest: approveAll,
|
||||
mcpServers: {
|
||||
playwright: {
|
||||
type: "local",
|
||||
|
||||
@@ -17,13 +17,16 @@ You need to handle various error conditions like connection failures, timeouts,
|
||||
## Basic try-catch
|
||||
|
||||
```typescript
|
||||
import { CopilotClient } from "@github/copilot-sdk";
|
||||
import { CopilotClient, approveAll } from "@github/copilot-sdk";
|
||||
|
||||
const client = new CopilotClient();
|
||||
|
||||
try {
|
||||
await client.start();
|
||||
const session = await client.createSession({ model: "gpt-5" });
|
||||
const session = await client.createSession({
|
||||
onPermissionRequest: approveAll,
|
||||
model: "gpt-5",
|
||||
});
|
||||
|
||||
const response = await session.sendAndWait({ prompt: "Hello!" });
|
||||
console.log(response?.data.content);
|
||||
@@ -55,7 +58,10 @@ try {
|
||||
## Timeout handling
|
||||
|
||||
```typescript
|
||||
const session = await client.createSession({ model: "gpt-5" });
|
||||
const session = await client.createSession({
|
||||
onPermissionRequest: approveAll,
|
||||
model: "gpt-5",
|
||||
});
|
||||
|
||||
try {
|
||||
// sendAndWait with timeout (in milliseconds)
|
||||
@@ -79,7 +85,10 @@ try {
|
||||
## Aborting a request
|
||||
|
||||
```typescript
|
||||
const session = await client.createSession({ model: "gpt-5" });
|
||||
const session = await client.createSession({
|
||||
onPermissionRequest: approveAll,
|
||||
model: "gpt-5",
|
||||
});
|
||||
|
||||
// Start a request
|
||||
session.send({ prompt: "Write a very long story..." });
|
||||
|
||||
@@ -17,7 +17,7 @@ You have a folder with many files and want to organize them into subfolders base
|
||||
## Example code
|
||||
|
||||
```typescript
|
||||
import { CopilotClient } from "@github/copilot-sdk";
|
||||
import { CopilotClient, approveAll } from "@github/copilot-sdk";
|
||||
import * as os from "node:os";
|
||||
import * as path from "node:path";
|
||||
|
||||
@@ -27,6 +27,7 @@ await client.start();
|
||||
|
||||
// Create session
|
||||
const session = await client.createSession({
|
||||
onPermissionRequest: approveAll,
|
||||
model: "gpt-5",
|
||||
});
|
||||
|
||||
|
||||
@@ -17,15 +17,24 @@ You need to run multiple conversations in parallel, each with its own context an
|
||||
## Node.js
|
||||
|
||||
```typescript
|
||||
import { CopilotClient } from "@github/copilot-sdk";
|
||||
import { CopilotClient, approveAll } from "@github/copilot-sdk";
|
||||
|
||||
const client = new CopilotClient();
|
||||
await client.start();
|
||||
|
||||
// Create multiple independent sessions
|
||||
const session1 = await client.createSession({ model: "gpt-5" });
|
||||
const session2 = await client.createSession({ model: "gpt-5" });
|
||||
const session3 = await client.createSession({ model: "claude-sonnet-4.5" });
|
||||
const session1 = await client.createSession({
|
||||
onPermissionRequest: approveAll,
|
||||
model: "gpt-5",
|
||||
});
|
||||
const session2 = await client.createSession({
|
||||
onPermissionRequest: approveAll,
|
||||
model: "gpt-5",
|
||||
});
|
||||
const session3 = await client.createSession({
|
||||
onPermissionRequest: approveAll,
|
||||
model: "claude-sonnet-4.5",
|
||||
});
|
||||
|
||||
// Each session maintains its own conversation history
|
||||
await session1.sendAndWait({ prompt: "You are helping with a Python project" });
|
||||
@@ -50,6 +59,7 @@ Use custom IDs for easier tracking:
|
||||
|
||||
```typescript
|
||||
const session = await client.createSession({
|
||||
onPermissionRequest: approveAll,
|
||||
sessionId: "user-123-chat",
|
||||
model: "gpt-5",
|
||||
});
|
||||
|
||||
@@ -17,13 +17,14 @@ You want users to be able to continue a conversation even after closing and reop
|
||||
### Creating a session with a custom ID
|
||||
|
||||
```typescript
|
||||
import { CopilotClient } from "@github/copilot-sdk";
|
||||
import { CopilotClient, approveAll } from "@github/copilot-sdk";
|
||||
|
||||
const client = new CopilotClient();
|
||||
await client.start();
|
||||
|
||||
// Create session with a memorable ID
|
||||
const session = await client.createSession({
|
||||
onPermissionRequest: approveAll,
|
||||
sessionId: "user-123-conversation",
|
||||
model: "gpt-5",
|
||||
});
|
||||
@@ -45,7 +46,7 @@ const client = new CopilotClient();
|
||||
await client.start();
|
||||
|
||||
// Resume the previous session
|
||||
const session = await client.resumeSession("user-123-conversation");
|
||||
const session = await client.resumeSession("user-123-conversation", { onPermissionRequest: approveAll });
|
||||
|
||||
// Previous context is restored
|
||||
await session.sendAndWait({ prompt: "What were we discussing?" });
|
||||
|
||||
@@ -42,7 +42,7 @@ npx tsx pr-visualization.ts --repo github/copilot-sdk
|
||||
|
||||
import { execSync } from "node:child_process";
|
||||
import * as readline from "node:readline";
|
||||
import { CopilotClient } from "@github/copilot-sdk";
|
||||
import { CopilotClient, approveAll } from "@github/copilot-sdk";
|
||||
|
||||
// ============================================================================
|
||||
// Git & GitHub Detection
|
||||
@@ -138,6 +138,7 @@ async function main() {
|
||||
const client = new CopilotClient({ logLevel: "error" });
|
||||
|
||||
const session = await client.createSession({
|
||||
onPermissionRequest: approveAll,
|
||||
model: "gpt-5",
|
||||
systemMessage: {
|
||||
content: `
|
||||
|
||||
@@ -43,7 +43,7 @@ The minimal Ralph loop — the SDK equivalent of `while :; do cat PROMPT.md | co
|
||||
|
||||
```typescript
|
||||
import { readFile } from "fs/promises";
|
||||
import { CopilotClient } from "@github/copilot-sdk";
|
||||
import { CopilotClient, approveAll } from "@github/copilot-sdk";
|
||||
|
||||
async function ralphLoop(promptFile: string, maxIterations: number = 50) {
|
||||
const client = new CopilotClient();
|
||||
@@ -56,7 +56,10 @@ async function ralphLoop(promptFile: string, maxIterations: number = 50) {
|
||||
console.log(`\n=== Iteration ${i}/${maxIterations} ===`);
|
||||
|
||||
// Fresh session each iteration — context isolation is the point
|
||||
const session = await client.createSession({ model: "gpt-5.1-codex-mini" });
|
||||
const session = await client.createSession({
|
||||
onPermissionRequest: approveAll,
|
||||
model: "gpt-5.1-codex-mini",
|
||||
});
|
||||
try {
|
||||
await session.sendAndWait({ prompt }, 600_000);
|
||||
} finally {
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
#!/usr/bin/env tsx
|
||||
|
||||
import { CopilotClient } from "@github/copilot-sdk";
|
||||
import { CopilotClient, approveAll } from "@github/copilot-sdk";
|
||||
import * as readline from "node:readline";
|
||||
|
||||
// ============================================================================
|
||||
@@ -38,6 +38,7 @@ async function main() {
|
||||
const client = new CopilotClient();
|
||||
|
||||
const session = await client.createSession({
|
||||
onPermissionRequest: approveAll,
|
||||
model: "claude-opus-4.6",
|
||||
streaming: true,
|
||||
mcpServers: {
|
||||
|
||||
@@ -1,10 +1,13 @@
|
||||
import { CopilotClient } from "@github/copilot-sdk";
|
||||
import { CopilotClient, approveAll } from "@github/copilot-sdk";
|
||||
|
||||
const client = new CopilotClient();
|
||||
|
||||
try {
|
||||
await client.start();
|
||||
const session = await client.createSession({ model: "gpt-5" });
|
||||
const session = await client.createSession({
|
||||
onPermissionRequest: approveAll,
|
||||
model: "gpt-5",
|
||||
});
|
||||
|
||||
const response = await session.sendAndWait({ prompt: "Hello!" });
|
||||
console.log(response?.data.content);
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
import { CopilotClient } from "@github/copilot-sdk";
|
||||
import { CopilotClient, approveAll } from "@github/copilot-sdk";
|
||||
import * as os from "node:os";
|
||||
import * as path from "node:path";
|
||||
|
||||
@@ -8,6 +8,7 @@ await client.start();
|
||||
|
||||
// Create session
|
||||
const session = await client.createSession({
|
||||
onPermissionRequest: approveAll,
|
||||
model: "gpt-5",
|
||||
});
|
||||
|
||||
|
||||
@@ -1,12 +1,21 @@
|
||||
import { CopilotClient } from "@github/copilot-sdk";
|
||||
import { CopilotClient, approveAll } from "@github/copilot-sdk";
|
||||
|
||||
const client = new CopilotClient();
|
||||
await client.start();
|
||||
|
||||
// Create multiple independent sessions
|
||||
const session1 = await client.createSession({ model: "gpt-5" });
|
||||
const session2 = await client.createSession({ model: "gpt-5" });
|
||||
const session3 = await client.createSession({ model: "claude-sonnet-4.5" });
|
||||
const session1 = await client.createSession({
|
||||
onPermissionRequest: approveAll,
|
||||
model: "gpt-5",
|
||||
});
|
||||
const session2 = await client.createSession({
|
||||
onPermissionRequest: approveAll,
|
||||
model: "gpt-5",
|
||||
});
|
||||
const session3 = await client.createSession({
|
||||
onPermissionRequest: approveAll,
|
||||
model: "claude-sonnet-4.5",
|
||||
});
|
||||
|
||||
console.log("Created 3 independent sessions");
|
||||
|
||||
|
||||
@@ -1,10 +1,11 @@
|
||||
import { CopilotClient } from "@github/copilot-sdk";
|
||||
import { CopilotClient, approveAll } from "@github/copilot-sdk";
|
||||
|
||||
const client = new CopilotClient();
|
||||
await client.start();
|
||||
|
||||
// Create a session with a memorable ID
|
||||
const session = await client.createSession({
|
||||
onPermissionRequest: approveAll,
|
||||
sessionId: "user-123-conversation",
|
||||
model: "gpt-5",
|
||||
});
|
||||
@@ -17,7 +18,7 @@ await session.destroy();
|
||||
console.log("Session destroyed (state persisted)");
|
||||
|
||||
// Resume the previous session
|
||||
const resumed = await client.resumeSession("user-123-conversation");
|
||||
const resumed = await client.resumeSession("user-123-conversation", { onPermissionRequest: approveAll });
|
||||
console.log(`Resumed: ${resumed.sessionId}`);
|
||||
|
||||
await resumed.sendAndWait({ prompt: "What were we discussing?" });
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
#!/usr/bin/env tsx
|
||||
|
||||
import { CopilotClient } from "@github/copilot-sdk";
|
||||
import { CopilotClient, approveAll } from "@github/copilot-sdk";
|
||||
import { execSync } from "node:child_process";
|
||||
import * as readline from "node:readline";
|
||||
|
||||
@@ -98,6 +98,7 @@ async function main() {
|
||||
const client = new CopilotClient({ logLevel: "error" });
|
||||
|
||||
const session = await client.createSession({
|
||||
onPermissionRequest: approveAll,
|
||||
model: "gpt-5",
|
||||
systemMessage: {
|
||||
content: `
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
import { readFile } from "fs/promises";
|
||||
import { CopilotClient } from "@github/copilot-sdk";
|
||||
import { CopilotClient, approveAll } from "@github/copilot-sdk";
|
||||
|
||||
/**
|
||||
* Ralph loop: autonomous AI task loop with fresh context per iteration.
|
||||
@@ -44,7 +44,7 @@ async function ralphLoop(mode: Mode, maxIterations: number) {
|
||||
// Pin the agent to the project directory
|
||||
workingDirectory: process.cwd(),
|
||||
// Auto-approve tool calls for unattended operation
|
||||
onPermissionRequest: async () => ({ allow: true }),
|
||||
onPermissionRequest: approveAll,
|
||||
});
|
||||
|
||||
// Log tool usage for visibility
|
||||
|
||||
@@ -35,8 +35,11 @@ python accessibility_report.py
|
||||
|
||||
import asyncio
|
||||
from copilot import (
|
||||
CopilotClient, SessionConfig, MessageOptions,
|
||||
CopilotClient,
|
||||
SessionConfig,
|
||||
MessageOptions,
|
||||
SessionEvent,
|
||||
PermissionHandler,
|
||||
)
|
||||
|
||||
# ============================================================================
|
||||
@@ -74,7 +77,7 @@ async def main():
|
||||
"tools": ["*"],
|
||||
}
|
||||
},
|
||||
))
|
||||
on_permission_request=PermissionHandler.approve_all))
|
||||
|
||||
done = asyncio.Event()
|
||||
|
||||
@@ -187,7 +190,7 @@ session = await client.create_session(SessionConfig(
|
||||
"tools": ["*"],
|
||||
}
|
||||
},
|
||||
))
|
||||
on_permission_request=PermissionHandler.approve_all))
|
||||
```
|
||||
|
||||
This gives the model access to Playwright browser tools like `browser_navigate`, `browser_snapshot`, and `browser_click`.
|
||||
|
||||
@@ -17,14 +17,15 @@ You need to handle various error conditions like connection failures, timeouts,
|
||||
|
||||
```python
|
||||
import asyncio
|
||||
from copilot import CopilotClient, SessionConfig, MessageOptions
|
||||
from copilot import CopilotClient, SessionConfig, MessageOptions, PermissionHandler
|
||||
|
||||
async def main():
|
||||
client = CopilotClient()
|
||||
|
||||
try:
|
||||
await client.start()
|
||||
session = await client.create_session(SessionConfig(model="gpt-5"))
|
||||
session = await client.create_session(SessionConfig(model="gpt-5",
|
||||
on_permission_request=PermissionHandler.approve_all))
|
||||
|
||||
response = await session.send_and_wait(MessageOptions(prompt="Hello!"))
|
||||
|
||||
@@ -57,7 +58,8 @@ except Exception as e:
|
||||
## Timeout handling
|
||||
|
||||
```python
|
||||
session = await client.create_session(SessionConfig(model="gpt-5"))
|
||||
session = await client.create_session(SessionConfig(model="gpt-5",
|
||||
on_permission_request=PermissionHandler.approve_all))
|
||||
|
||||
try:
|
||||
# send_and_wait accepts an optional timeout in seconds
|
||||
@@ -73,7 +75,8 @@ except TimeoutError:
|
||||
## Aborting a request
|
||||
|
||||
```python
|
||||
session = await client.create_session(SessionConfig(model="gpt-5"))
|
||||
session = await client.create_session(SessionConfig(model="gpt-5",
|
||||
on_permission_request=PermissionHandler.approve_all))
|
||||
|
||||
# Start a request (non-blocking send)
|
||||
await session.send(MessageOptions(prompt="Write a very long story..."))
|
||||
|
||||
@@ -19,8 +19,11 @@ You have a folder with many files and want to organize them into subfolders base
|
||||
import asyncio
|
||||
import os
|
||||
from copilot import (
|
||||
CopilotClient, SessionConfig, MessageOptions,
|
||||
CopilotClient,
|
||||
SessionConfig,
|
||||
MessageOptions,
|
||||
SessionEvent,
|
||||
PermissionHandler,
|
||||
)
|
||||
|
||||
async def main():
|
||||
@@ -29,7 +32,8 @@ async def main():
|
||||
await client.start()
|
||||
|
||||
# Create session
|
||||
session = await client.create_session(SessionConfig(model="gpt-5"))
|
||||
session = await client.create_session(SessionConfig(model="gpt-5",
|
||||
on_permission_request=PermissionHandler.approve_all))
|
||||
|
||||
done = asyncio.Event()
|
||||
|
||||
|
||||
@@ -17,16 +17,19 @@ You need to run multiple conversations in parallel, each with its own context an
|
||||
|
||||
```python
|
||||
import asyncio
|
||||
from copilot import CopilotClient, SessionConfig, MessageOptions
|
||||
from copilot import CopilotClient, SessionConfig, MessageOptions, PermissionHandler
|
||||
|
||||
async def main():
|
||||
client = CopilotClient()
|
||||
await client.start()
|
||||
|
||||
# Create multiple independent sessions
|
||||
session1 = await client.create_session(SessionConfig(model="gpt-5"))
|
||||
session2 = await client.create_session(SessionConfig(model="gpt-5"))
|
||||
session3 = await client.create_session(SessionConfig(model="claude-sonnet-4.5"))
|
||||
session1 = await client.create_session(SessionConfig(model="gpt-5",
|
||||
on_permission_request=PermissionHandler.approve_all))
|
||||
session2 = await client.create_session(SessionConfig(model="gpt-5",
|
||||
on_permission_request=PermissionHandler.approve_all))
|
||||
session3 = await client.create_session(SessionConfig(model="claude-sonnet-4.5",
|
||||
on_permission_request=PermissionHandler.approve_all))
|
||||
|
||||
# Each session maintains its own conversation history
|
||||
await session1.send(MessageOptions(prompt="You are helping with a Python project"))
|
||||
@@ -55,8 +58,8 @@ Use custom IDs for easier tracking:
|
||||
```python
|
||||
session = await client.create_session(SessionConfig(
|
||||
session_id="user-123-chat",
|
||||
model="gpt-5"
|
||||
))
|
||||
model="gpt-5",
|
||||
on_permission_request=PermissionHandler.approve_all))
|
||||
|
||||
print(session.session_id) # "user-123-chat"
|
||||
```
|
||||
|
||||
@@ -17,7 +17,7 @@ You want users to be able to continue a conversation even after closing and reop
|
||||
|
||||
```python
|
||||
import asyncio
|
||||
from copilot import CopilotClient, SessionConfig, MessageOptions
|
||||
from copilot import CopilotClient, SessionConfig, MessageOptions, PermissionHandler
|
||||
|
||||
async def main():
|
||||
client = CopilotClient()
|
||||
@@ -27,7 +27,7 @@ async def main():
|
||||
session = await client.create_session(SessionConfig(
|
||||
session_id="user-123-conversation",
|
||||
model="gpt-5",
|
||||
))
|
||||
on_permission_request=PermissionHandler.approve_all))
|
||||
|
||||
await session.send_and_wait(MessageOptions(prompt="Let's discuss TypeScript generics"))
|
||||
|
||||
@@ -49,7 +49,7 @@ client = CopilotClient()
|
||||
await client.start()
|
||||
|
||||
# Resume the previous session
|
||||
session = await client.resume_session("user-123-conversation")
|
||||
session = await client.resume_session("user-123-conversation", on_permission_request=PermissionHandler.approve_all)
|
||||
|
||||
# Previous context is restored
|
||||
await session.send_and_wait(MessageOptions(prompt="What were we discussing?"))
|
||||
|
||||
@@ -44,8 +44,11 @@ import sys
|
||||
import os
|
||||
import re
|
||||
from copilot import (
|
||||
CopilotClient, SessionConfig, MessageOptions,
|
||||
CopilotClient,
|
||||
SessionConfig,
|
||||
MessageOptions,
|
||||
SessionEvent,
|
||||
PermissionHandler,
|
||||
)
|
||||
|
||||
# ============================================================================
|
||||
@@ -150,8 +153,8 @@ The current working directory is: {os.getcwd()}
|
||||
- Be concise in your responses
|
||||
</instructions>
|
||||
"""
|
||||
}
|
||||
))
|
||||
},
|
||||
on_permission_request=PermissionHandler.approve_all))
|
||||
|
||||
done = asyncio.Event()
|
||||
|
||||
|
||||
@@ -48,7 +48,7 @@ The minimal Ralph loop — the SDK equivalent of `while :; do cat PROMPT.md | co
|
||||
```python
|
||||
import asyncio
|
||||
from pathlib import Path
|
||||
from copilot import CopilotClient, MessageOptions, SessionConfig
|
||||
from copilot import CopilotClient, MessageOptions, SessionConfig, PermissionHandler
|
||||
|
||||
|
||||
async def ralph_loop(prompt_file: str, max_iterations: int = 50):
|
||||
@@ -63,7 +63,8 @@ async def ralph_loop(prompt_file: str, max_iterations: int = 50):
|
||||
|
||||
# Fresh session each iteration — context isolation is the point
|
||||
session = await client.create_session(
|
||||
SessionConfig(model="gpt-5.1-codex-mini")
|
||||
SessionConfig(model="gpt-5.1-codex-mini",
|
||||
on_permission_request=PermissionHandler.approve_all)
|
||||
)
|
||||
try:
|
||||
await session.send_and_wait(
|
||||
|
||||
@@ -2,8 +2,11 @@
|
||||
|
||||
import asyncio
|
||||
from copilot import (
|
||||
CopilotClient, SessionConfig, MessageOptions,
|
||||
CopilotClient,
|
||||
SessionConfig,
|
||||
MessageOptions,
|
||||
SessionEvent,
|
||||
PermissionHandler,
|
||||
)
|
||||
|
||||
# ============================================================================
|
||||
@@ -41,7 +44,7 @@ async def main():
|
||||
"tools": ["*"],
|
||||
}
|
||||
},
|
||||
))
|
||||
on_permission_request=PermissionHandler.approve_all))
|
||||
|
||||
done = asyncio.Event()
|
||||
|
||||
|
||||
@@ -1,14 +1,15 @@
|
||||
#!/usr/bin/env python3
|
||||
|
||||
import asyncio
|
||||
from copilot import CopilotClient, SessionConfig, MessageOptions
|
||||
from copilot import CopilotClient, SessionConfig, MessageOptions, PermissionHandler
|
||||
|
||||
async def main():
|
||||
client = CopilotClient()
|
||||
|
||||
try:
|
||||
await client.start()
|
||||
session = await client.create_session(SessionConfig(model="gpt-5"))
|
||||
session = await client.create_session(SessionConfig(model="gpt-5",
|
||||
on_permission_request=PermissionHandler.approve_all))
|
||||
|
||||
response = await session.send_and_wait(MessageOptions(prompt="Hello!"))
|
||||
|
||||
|
||||
@@ -3,8 +3,11 @@
|
||||
import asyncio
|
||||
import os
|
||||
from copilot import (
|
||||
CopilotClient, SessionConfig, MessageOptions,
|
||||
CopilotClient,
|
||||
SessionConfig,
|
||||
MessageOptions,
|
||||
SessionEvent,
|
||||
PermissionHandler,
|
||||
)
|
||||
|
||||
async def main():
|
||||
@@ -13,7 +16,8 @@ async def main():
|
||||
await client.start()
|
||||
|
||||
# Create session
|
||||
session = await client.create_session(SessionConfig(model="gpt-5"))
|
||||
session = await client.create_session(SessionConfig(model="gpt-5",
|
||||
on_permission_request=PermissionHandler.approve_all))
|
||||
|
||||
done = asyncio.Event()
|
||||
|
||||
|
||||
@@ -1,16 +1,19 @@
|
||||
#!/usr/bin/env python3
|
||||
|
||||
import asyncio
|
||||
from copilot import CopilotClient, SessionConfig, MessageOptions
|
||||
from copilot import CopilotClient, SessionConfig, MessageOptions, PermissionHandler
|
||||
|
||||
async def main():
|
||||
client = CopilotClient()
|
||||
await client.start()
|
||||
|
||||
# Create multiple independent sessions
|
||||
session1 = await client.create_session(SessionConfig(model="gpt-5"))
|
||||
session2 = await client.create_session(SessionConfig(model="gpt-5"))
|
||||
session3 = await client.create_session(SessionConfig(model="claude-sonnet-4.5"))
|
||||
session1 = await client.create_session(SessionConfig(model="gpt-5",
|
||||
on_permission_request=PermissionHandler.approve_all))
|
||||
session2 = await client.create_session(SessionConfig(model="gpt-5",
|
||||
on_permission_request=PermissionHandler.approve_all))
|
||||
session3 = await client.create_session(SessionConfig(model="claude-sonnet-4.5",
|
||||
on_permission_request=PermissionHandler.approve_all))
|
||||
|
||||
print("Created 3 independent sessions")
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
#!/usr/bin/env python3
|
||||
|
||||
import asyncio
|
||||
from copilot import CopilotClient, SessionConfig, MessageOptions
|
||||
from copilot import CopilotClient, SessionConfig, MessageOptions, PermissionHandler
|
||||
|
||||
async def main():
|
||||
client = CopilotClient()
|
||||
@@ -11,7 +11,7 @@ async def main():
|
||||
session = await client.create_session(SessionConfig(
|
||||
session_id="user-123-conversation",
|
||||
model="gpt-5",
|
||||
))
|
||||
on_permission_request=PermissionHandler.approve_all))
|
||||
|
||||
await session.send_and_wait(MessageOptions(prompt="Let's discuss TypeScript generics"))
|
||||
print(f"Session created: {session.session_id}")
|
||||
@@ -21,7 +21,7 @@ async def main():
|
||||
print("Session destroyed (state persisted)")
|
||||
|
||||
# Resume the previous session
|
||||
resumed = await client.resume_session("user-123-conversation")
|
||||
resumed = await client.resume_session("user-123-conversation", on_permission_request=PermissionHandler.approve_all)
|
||||
print(f"Resumed: {resumed.session_id}")
|
||||
|
||||
await resumed.send_and_wait(MessageOptions(prompt="What were we discussing?"))
|
||||
|
||||
@@ -6,8 +6,11 @@ import sys
|
||||
import os
|
||||
import re
|
||||
from copilot import (
|
||||
CopilotClient, SessionConfig, MessageOptions,
|
||||
CopilotClient,
|
||||
SessionConfig,
|
||||
MessageOptions,
|
||||
SessionEvent,
|
||||
PermissionHandler,
|
||||
)
|
||||
|
||||
# ============================================================================
|
||||
@@ -112,8 +115,8 @@ The current working directory is: {os.getcwd()}
|
||||
- Be concise in your responses
|
||||
</instructions>
|
||||
"""
|
||||
}
|
||||
))
|
||||
},
|
||||
on_permission_request=PermissionHandler.approve_all))
|
||||
|
||||
done = asyncio.Event()
|
||||
|
||||
|
||||
@@ -22,7 +22,7 @@ import asyncio
|
||||
import sys
|
||||
from pathlib import Path
|
||||
|
||||
from copilot import CopilotClient, MessageOptions, SessionConfig
|
||||
from copilot import CopilotClient, MessageOptions, SessionConfig, PermissionHandler
|
||||
|
||||
|
||||
async def ralph_loop(mode: str = "build", max_iterations: int = 50):
|
||||
@@ -48,10 +48,7 @@ async def ralph_loop(mode: str = "build", max_iterations: int = 50):
|
||||
# Pin the agent to the project directory
|
||||
working_directory=str(Path.cwd()),
|
||||
# Auto-approve tool calls for unattended operation
|
||||
on_permission_request=lambda _req, _ctx: {
|
||||
"kind": "approved",
|
||||
"rules": [],
|
||||
},
|
||||
on_permission_request=PermissionHandler.approve_all,
|
||||
))
|
||||
|
||||
# Log tool usage for visibility
|
||||
|
||||
Reference in New Issue
Block a user