Skip to main content

CLI Commands

Goose provides a command-line interface (CLI) with several commands for managing sessions, configurations and extensions. Below is a list of the available commands and their descriptions:

Commands​

help​

Used to display the help menu

Usage:

goose --help

configure [options]​

Configure Goose settings - providers, extensions, etc.

Usage:

goose configure

session [options]​

  • Start a session and give it a name

    Options:

    -n, --name <name>

    Usage:

    goose session --name <name>

  • Resume a previous session

    Options:

    -r, --resume

    Usage:

    goose session --resume --name <name>

  • Start a session with the specified extension

    Options:

    --with-extension <command>

    Usage:

    goose session --with-extension <command>

    Examples:

    goose session --with-extension "npx -y @modelcontextprotocol/server-memory"

    With environment variable:

    goose session --with-extension "GITHUB_PERSONAL_ACCESS_TOKEN=<YOUR_TOKEN> npx -y @modelcontextprotocol/server-github"

  • Start a session with the specified remote extension over SSE

    Options:

    --with-remote-extension <url>

    Usage:

    goose session --with-remote-extension <url>

    Examples:

    goose session --with-remote-extension "http://localhost:8080/sse"

  • Start a session with the specified built-in extension enabled (e.g. 'developer')

    Options:

    --with-builtin <id>

    Usage:

    goose session --with-builtin <id>

    Example:

    goose session --with-builtin computercontroller

session list [options]​

List all saved sessions.

  • -v, --verbose: (Optional) Includes session file paths in the output.
  • -f, --format <format>: Specify output format (text or json). Default is text.

Usage:

# List all sessions in text format (default)
goose session list
# List sessions with file paths
goose session list --verbose
# List sessions in JSON format
goose session list --format json

info [options]​

Shows Goose information, including the version, configuration file location, session storage, and logs.

  • -v, --verbose: (Optional) Show detailed configuration settings, including environment variables and enabled extensions.

Usage:

goose info

version​

Used to check the current Goose version you have installed

Usage:

goose --version

update [options]​

Update the Goose CLI to a newer version.

Options:

  • --canary, -c: Update to the canary (development) version instead of the stable version
  • --reconfigure, -r: Forces Goose to reset configuration settings during the update process

Usage:

# Update to latest stable version
goose update

# Update to latest canary version
goose update --canary

# Update and reconfigure settings
goose update --reconfigure

mcp​

Run an enabled MCP server specified by <name> (e.g. 'Google Drive')

Usage:

goose mcp <name>

run [options]​

Execute commands from an instruction file or stdin. Check out the full guide for more info.

Options:

  • -i, --instructions <FILE>: Path to instruction file containing commands. Use - for stdin.
  • -t, --text <TEXT>: Input text to provide to Goose directly
  • -s, --interactive: Continue in interactive mode after processing initial input
  • -n, --name <NAME>: Name for this run session (e.g. daily-tasks)
  • -r, --resume: Resume from a previous run
  • --recipe <RECIPE_FILE_NAME> <OPTIONS>: Load a custom recipe in current session
  • -p, --path <PATH>: Path for this run session (e.g. ./playground.jsonl)
  • --with-extension <COMMAND>: Add stdio extensions (can be used multiple times in the same command)
  • --with-builtin <NAME>: Add builtin extensions by name (e.g., 'developer' or multiple: 'developer,github')

Usage:

goose run --instructions plan.md

#Load a recipe with a prompt that Goose executes and then exits  
goose run --recipe recipe.yaml

#Load a recipe from this chat and then stays in an interactive session
goose run --recipe recipe.yaml -s

#Load a recipe containing a prompt which Goose executes and then drops into an interactive session
goose run --recipe recipe.yaml --interactive

#Generates an error: no text provided for prompt in headless mode
goose run --recipe recipe_no_prompt.yaml

bench​

Used to evaluate system-configuration across a range of practical tasks. See the detailed guide for more information.

Usage:

goose bench ...etc.

recipe​

Used to validate a recipe file and get a link to share the recipe (aka "shared agent") with another Goose user.

goose recipe <COMMAND>

Options:

  • --help, -h: Print this message or the help for the subcommand

Command Usage:

# Validate a recipe file
goose recipe validate $FILE.yaml

# Generate a deeplink for a recipe file
goose recipe deeplink $FILE.yaml

# Print this message or the help for the given command
goose recipe help

Prompt Completion​

The CLI provides a set of slash commands that can be accessed during a session. These commands support tab completion for easier use.

Available Commands​

  • /exit or /quit - Exit the current session
  • /t - Toggle between Light/Dark/Ansi themes
  • /extension <command> - Add a stdio extension (format: ENV1=val1 command args...)
  • /builtin <names> - Add builtin extensions by name (comma-separated)
  • /prompts [--extension <name>] - List all available prompts, optionally filtered by extension
  • /prompt <n> [--info] [key=value...] - Get prompt info or execute a prompt
  • /mode <name> - Set the goose mode to use ('auto', 'approve', 'chat')
  • /plan <message> - Create a structured plan based on the given message
  • /? or /help - Display this help message
  • /recipe <recipe file name> - Generate and save a session recipe to recipe.yaml or the filename specified by the command parameter.

All commands support tab completion. Press <Tab> after a slash (/) to cycle through available commands or to complete partial commands.

Examples​

# Create a plan for triaging test failures
/plan let's create a plan for triaging test failures

# List all prompts from the developer extension
/prompts --extension developer

# Switch to chat mode
/mode chat

Keyboard Shortcuts​

Goose CLI supports several shortcuts and built-in commands for easier navigation.

  • Ctrl+C - Interrupt the current request
  • Ctrl+J - Add a newline
  • Cmd+Up/Down arrows - Navigate through command history