Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Reference for guild session: create, list, and inspect Guild sessions, send them messages, interrupt them, and list their events and tasks.
--workspace. If no default is set, run guild workspace select.
guild session list # List sessions in the default workspace
guild session get <session-id> # Get session details
guild session events <session-id> # List events in a session
guild session send <session-id> --message "Thanks, now open a PR" # Send a user message
guild session create --prompt "Summarize open issues" --agent <identifier> # Start a chat session
guild session create --type agent_test --agent <identifier> # Start an agent test session
guild session create --workspace <id> --prompt "Hello" # Specify a workspace
| Option | Description |
|---|---|
--agent <identifier> | The agent, such as owner~agent-name. |
--prompt <text> | The initial prompt. Required for chat sessions. |
--type <type> | The session type: chat or agent_test. Defaults to chat. |
--workspace <id> | The workspace ID or name, such as owner~workspace-name. |
--events accepts.
guild session events <session-id> # List user-facing events
guild session events <session-id> --events all # Include system and debug events
guild session events <session-id> --limit 50 --offset 50 # Paginate (default limit: 100)
| Argument | Description |
|---|---|
<session-id> | The session ID. |
| Option | Description |
|---|---|
--events <types> | The event types to show: user, system, all, or comma-separated type names. Defaults to user. Unlike in chat and agent test, none doesn’t hide events here: it sends no type filter, so every event is listed. |
--limit <number> | The number of results to return. Defaults to 100. |
--offset <number> | The offset for pagination. Defaults to 0. |
guild session get <session-id> # Get session details
| Argument | Description |
|---|---|
<session-id> | The session ID. |
guild session interrupt <session-id> # Interrupt a running session
| Argument | Description |
|---|---|
<session-id> | The session ID. |
guild session list # List sessions in the default workspace
guild session list --workspace <id> # Specify a workspace
guild session list --type chat # Filter by type: chat, webhook, time, agent_test
guild session list --limit 50 --offset 50 # Paginate
| Option | Description |
|---|---|
--limit <number> | The number of results to return. Defaults to 20. |
--offset <number> | The offset for pagination. Defaults to 0. |
--type <type> | Filter by session type: chat, webhook, time, or agent_test. |
--workspace <id> | The workspace ID or name, such as owner~workspace-name. |
--message or --json.
guild session send <session-id> --message "Thanks, now open a PR" # Send a text message
guild session send <session-id> --json '{"approved": true}' # Send a JSON content object
| Argument | Description |
|---|---|
<session-id> | The session ID. |
| Option | Description |
|---|---|
--json <json> | A JSON content object. Sends the message in json mode. Takes precedence over --message. |
--message <text> | The text message content. |
guild session tasks <session-id> # List tasks in a session
guild session tasks <session-id> --limit 50 --offset 50 # Paginate
| Argument | Description |
|---|---|
<session-id> | The session ID. |
| Option | Description |
|---|---|
--limit <number> | The number of results to return. Defaults to 100. |
--offset <number> | The offset for pagination. Defaults to 0. |