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

version​

Used to check the current Goose version you have installed

Usage:

goose --version

agents​

Used to list all available agents

Usage:

goose agents

mcp​

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

Usage:

goose mcp <name>

session [options]​

Start or resume sessions with the following options.

Options:

  • -n, --name <NAME>

Name for the new chat session (e.g. 'project-x')

goose session --name <name>
  • -r, --resume

Resume a previous session (last used or specified by --name)

goose session --name <name> --resume
  • --with-extension <COMMAND>

Starts the session with the specified extension. Can also include environment variables (e.g., 'GITHUB_TOKEN=xyz npx -y @modelcontextprotocol/server-github').

goose session --name <name> --with-extension <command>
  • --with-builtin <NAME>

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

goose session --with-builtin <name>

run [options]​

Execute commands from an instruction file or stdin

  • -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

configure [options]​

Configure Goose settings - providers, extensions, etc.

Usage:

goose configure'