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:
@@ -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..." });
|
||||
|
||||
Reference in New Issue
Block a user