Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.guild.ai/llms.txt

Use this file to discover all available pages before exploring further.

auth

Manage authentication.
guild auth login              # Log in via browser OAuth
guild auth logout             # Remove stored token
guild auth status             # Show authentication state
guild auth token              # Print the current auth token

agent

Build and manage agents.

Development workflow

# Initialize the current directory as a new agent
guild agent init
guild agent init --name my-agent
guild agent init --name my-agent --template LLM
guild agent init --fork <agent-id>   # Start from an existing agent
Templates: LLM (default), AUTO_MANAGED_STATE, BLANK
# Save changes (commits code and syncs with Guild)
guild agent save --message "Add rate limiting"
guild agent save --message "Fix bug" --wait       # Wait for validation
guild agent save --message "Ship it" --wait --publish  # Save and publish

# Pull remote changes into the local directory
guild agent pull

# Test the agent in the current directory
guild agent test
guild agent test "Summarize this PR: github.com/org/repo/pull/42"

# Chat with the agent you're developing
guild agent chat

Publishing

guild agent publish              # Publish the latest draft version
guild agent publish --wait       # Wait for validation before publishing
guild agent unpublish            # Unpublish the latest published version
guild agent versions             # List all versions

Discovery and management

guild agent list                             # List your agents
guild agent search "code review"             # Search published agents
guild agent get <agent-id>                   # Get agent details
guild agent create <name>                    # Create an agent record
guild agent update <agent-id> --description "New description"
guild agent clone <agent-id>                 # Clone an agent's code locally
guild agent code <agent-id>                  # Fetch published code
guild agent code <agent-id> --draft          # Include draft versions

Tags

guild agent tags list              # List tags on the current agent
guild agent tags add analytics     # Add a tag
guild agent tags remove analytics  # Remove a tag

workspace

Manage workspaces and their contents.
guild workspace list                    # List all accessible workspaces
guild workspace create <name>           # Create a new workspace
guild workspace get <identifier>        # Get workspace details
guild workspace select                  # Set the default workspace (interactive)
guild workspace select <id-or-name>     # Set the default workspace directly
guild workspace current                 # Show current default workspace

Workspace agents

guild workspace agent list                    # List agents installed in workspace
guild workspace agent add <identifier>        # Install an agent
guild workspace agent remove <identifier>     # Remove an agent

Workspace context

guild workspace context list <workspace-id>                      # List context versions
guild workspace context get <workspace-id> <context-id>          # Get a version
guild workspace context edit <workspace-id>                      # Edit in $EDITOR, creates draft
guild workspace context edit <workspace-id> --from <context-id>  # Edit from a specific version
guild workspace context publish <workspace-id> <context-id>      # Publish a draft

chat

Start a conversation with an agent.
guild chat                                   # Interactive chat with the Guild assistant
guild chat "Summarize my open PRs"           # Start with an initial message
guild chat --agent <identifier>              # Chat with a specific agent
guild chat --workspace <identifier>          # Use a specific workspace
guild chat --once "What is 2 + 2?"           # One-shot: send message and exit
guild chat --resume <session-id>             # Resume a previous session
To chat with the agent you’re currently developing, use guild agent chat from inside the agent directory.

session

Inspect sessions in a workspace.
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 get <session-id>               # Get session details
guild session events <session-id>            # Stream session events
guild session tasks <session-id>             # List tasks in a session
guild session send <session-id> <message>    # Send a message to an active session

trigger

Automate agent execution. See Triggers for a full guide.
guild trigger list                           # List triggers in the default workspace
guild trigger get <trigger-id>               # Get trigger details
guild trigger sessions <trigger-id>          # List sessions spawned by a trigger

# Create a webhook trigger
guild trigger create --type webhook --service SLACK --event app_mention --agent <identifier>

# Create a time trigger
guild trigger create --type time --frequency DAILY --time 09:00 --agent <identifier>

guild trigger update <trigger-id> --time 10:00
guild trigger activate <trigger-id>
guild trigger deactivate <trigger-id>

integration

Build and manage custom integrations.

Discovery and management

guild integration list                        # List integrations
guild integration list --search "deploy"      # Search by name or description
guild integration list --published            # Only show published integrations
guild integration get <id_or_name>            # Get integration details

Creating and updating

# Create a new integration with API key auth
guild integration create my-service \
  --base-url https://api.example.com \
  --auth-scheme api-key \
  --description "Connect to the Acme API"

# Create with OAuth
guild integration create my-oauth-service \
  --base-url https://api.example.com \
  --auth-scheme oauth \
  --install-url https://example.com/oauth/authorize \
  --token-url https://example.com/oauth/token \
  --client-id <id> --client-secret <secret> \
  --scopes "read,write"

# Update an existing integration
guild integration update myorg~my-service --description "Updated description"
guild integration update myorg~my-service --base-url https://api.v2.example.com

Connecting credentials

guild integration connect myorg~my-service                  # Interactive prompt
guild integration connect myorg~my-service --token <value>  # Non-interactive

Versions

guild integration version list <id_or_name>                 # List versions
guild integration version create <id_or_name>               # Create a draft version
guild integration version get <id_or_name>                  # Get latest version details
guild integration version get <id_or_name> --version-number 1.0.0

guild integration version build <id_or_name> --version-number 1.0.0   # Validate a draft
guild integration version publish <id_or_name> --version-number 1.0.0 # Publish a built version

Operations (endpoints)

# List operations on a version
guild integration operation list <id_or_name>
guild integration operation list <id_or_name> --version-number 1.0.0

# Add operations manually
guild integration operation create myorg~my-service \
  --operation list_users \
  --method GET \
  --path /users \
  --summary "List all users"

# Import operations from an OpenAPI spec
guild integration operation create myorg~my-service --openapi ./openapi.yaml

Testing

guild integration version test myorg~my-service \
  --operation list_users \
  --account my-account \
  --input-query '{"limit": 10}'

config

Read and write global CLI configuration.
guild config list               # Show all config values
guild config get <key>          # Read a value
guild config set <key> <value>  # Write a value
guild config path               # Show path to config file
Keys: default_workspace, debug, json, quiet

Utilities

guild doctor     # Diagnose setup issues (auth, server, workspace, git)
guild setup      # Install coding assistant skills in the current project
guild version    # Show the CLI version