mirror of
https://github.com/github/awesome-copilot.git
synced 2026-03-23 09:35:13 +00:00
33f544c71d
* 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>
99 lines
2.3 KiB
Markdown
99 lines
2.3 KiB
Markdown
# Session Persistence and Resumption
|
|
|
|
Save and restore conversation sessions across application restarts.
|
|
|
|
## Example scenario
|
|
|
|
You want users to be able to continue a conversation even after closing and reopening your application.
|
|
|
|
> **Runnable example:** [recipe/persisting-sessions.go](recipe/persisting-sessions.go)
|
|
>
|
|
> ```bash
|
|
> cd recipe
|
|
> go run persisting-sessions.go
|
|
> ```
|
|
|
|
### Creating a session with a custom ID
|
|
|
|
```go
|
|
package main
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
copilot "github.com/github/copilot-sdk/go"
|
|
)
|
|
|
|
func main() {
|
|
ctx := context.Background()
|
|
client := copilot.NewClient(nil)
|
|
client.Start(ctx)
|
|
defer client.Stop()
|
|
|
|
// Create session with a memorable ID
|
|
session, _ := client.CreateSession(ctx, &copilot.SessionConfig{
|
|
OnPermissionRequest: copilot.PermissionHandler.ApproveAll,
|
|
SessionID: "user-123-conversation",
|
|
Model: "gpt-5",
|
|
})
|
|
|
|
session.SendAndWait(ctx, copilot.MessageOptions{Prompt: "Let's discuss TypeScript generics"})
|
|
|
|
// Session ID is preserved
|
|
fmt.Println(session.SessionID)
|
|
|
|
// Destroy session but keep data on disk
|
|
session.Destroy()
|
|
}
|
|
```
|
|
|
|
### Resuming a session
|
|
|
|
```go
|
|
ctx := context.Background()
|
|
client := copilot.NewClient(nil)
|
|
client.Start(ctx)
|
|
defer client.Stop()
|
|
|
|
// Resume the previous session
|
|
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?"})
|
|
|
|
session.Destroy()
|
|
```
|
|
|
|
### Listing available sessions
|
|
|
|
```go
|
|
sessions, _ := client.ListSessions(ctx)
|
|
for _, s := range sessions {
|
|
fmt.Println("Session:", s.SessionID)
|
|
}
|
|
```
|
|
|
|
### Deleting a session permanently
|
|
|
|
```go
|
|
// Remove session and all its data from disk
|
|
client.DeleteSession(ctx, "user-123-conversation")
|
|
```
|
|
|
|
### Getting session history
|
|
|
|
```go
|
|
messages, _ := session.GetMessages(ctx)
|
|
for _, msg := range messages {
|
|
if msg.Data.Content != nil {
|
|
fmt.Printf("[%s] %s\n", msg.Type, *msg.Data.Content)
|
|
}
|
|
}
|
|
```
|
|
|
|
## Best practices
|
|
|
|
1. **Use meaningful session IDs**: Include user ID or context in the session ID
|
|
2. **Handle missing sessions**: Check if a session exists before resuming
|
|
3. **Clean up old sessions**: Periodically delete sessions that are no longer needed
|