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>

    Can also include environment variables (e.g., 'GITHUB_TOKEN={your_token} npx -y @modelcontextprotocol/server-github')

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

    Options:

    --with-builtin <id>

    Usage:

    goose session --with-builtin <id>

info [options]​

Shows Goose information, where goose will load config.yaml, store data and logs.

  • -v, --verbose: Show verbose information including config.yaml

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

Options:

  • -i, --instructions <FILE>: Path to instruction file containing commands
  • -t, --text <TEXT>: Input text to provide to Goose directly
  • -n, --name <NAME>: Name for this run session (e.g., 'daily-tasks')
  • -r, --resume: Resume from a previous run

Usage:

goose run --instructions plan.md

agents​

Used to show the available implementations of the agent loop itself

Usage:

goose agents