2025-01-24 13:04:43 -08:00
---
2025-02-20 11:03:56 +01:00
sidebar_position: 4
2025-01-24 13:04:43 -08:00
---
# 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: **
``` bash
goose --help
```
2025-02-24 08:03:37 -06:00
---
2025-01-24 13:04:43 -08:00
2025-02-24 08:03:37 -06:00
### configure [options]
Configure Goose settings - providers, extensions, etc.
2025-01-24 13:04:43 -08:00
**Usage: **
``` bash
2025-02-24 08:03:37 -06:00
goose configure
2025-01-24 13:04:43 -08:00
```
2025-02-24 08:03:37 -06:00
---
2025-01-24 13:04:43 -08:00
2025-02-24 08:03:37 -06:00
### session [options]
2025-01-24 13:04:43 -08:00
2025-02-24 08:03:37 -06:00
- Start a session and give it a name
2025-01-24 13:04:43 -08:00
2025-02-24 08:03:37 -06:00
**Options: **
2025-01-24 13:04:43 -08:00
2025-02-24 08:03:37 -06:00
* * `-n, --name <name>` **
2025-01-24 13:04:43 -08:00
2025-02-24 08:03:37 -06:00
**Usage: **
2025-01-24 13:04:43 -08:00
2025-02-24 08:03:37 -06:00
```bash
goose session --name <name>
` ``
2025-01-24 13:04:43 -08:00
2025-02-24 08:03:37 -06:00
- Resume a previous session
2025-01-24 13:04:43 -08:00
2025-02-24 08:03:37 -06:00
**Options:**
2025-01-24 13:04:43 -08:00
2025-02-24 08:03:37 -06:00
**` -r, --resume`**
2025-01-24 13:04:43 -08:00
2025-02-24 08:03:37 -06:00
**Usage:**
` ``bash
goose session --resume --name <name>
` ``
- Start a session with the specified extension
**Options:**
**` --with-extension <command>`**
**Usage:**
` ``bash
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](/docs/getting-started/using-extensions#built-in-extensions) enabled (e.g. 'developer')
**Options:**
**` --with-builtin <id>`**
**Usage:**
` ``bash
goose session --with-builtin <id>
` ``
---
2025-01-24 13:04:43 -08:00
2025-02-24 08:03:37 -06:00
### info [options]
Shows Goose information, where goose will load ` config.yaml`, store data and logs.
2025-01-24 13:04:43 -08:00
2025-02-24 08:03:37 -06:00
- **` -v, --verbose`**: Show verbose information including config.yaml
2025-01-24 13:04:43 -08:00
2025-02-24 08:03:37 -06:00
**Usage:**
2025-01-24 13:04:43 -08:00
` ``bash
2025-02-24 08:03:37 -06:00
goose info
2025-01-24 13:04:43 -08:00
` ``
2025-02-24 08:03:37 -06:00
---
2025-01-24 13:04:43 -08:00
2025-02-24 08:03:37 -06:00
### version
2025-01-24 13:04:43 -08:00
2025-02-24 08:03:37 -06:00
Used to check the current Goose version you have installed
**Usage:**
2025-01-24 13:04:43 -08:00
` ``bash
2025-02-24 08:03:37 -06:00
goose --version
2025-01-24 13:04:43 -08:00
` ``
2025-02-24 08:03:37 -06:00
---
2025-01-24 13:04:43 -08:00
2025-02-24 08:03:37 -06:00
### mcp
Run an enabled MCP server specified by ` <name>` (e.g. 'Google Drive')
2025-01-24 13:04:43 -08:00
2025-02-24 08:03:37 -06:00
**Usage:**
2025-01-24 13:04:43 -08:00
` ``bash
2025-02-24 08:03:37 -06:00
goose mcp <name>
2025-01-24 13:04:43 -08:00
` ``
2025-02-24 08:03:37 -06:00
---
2025-01-24 13:04:43 -08:00
### run [options]
Execute commands from an instruction file or stdin
2025-02-24 08:03:37 -06:00
**Options:**
2025-02-18 10:29:03 -08:00
- **` -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
2025-01-24 13:04:43 -08:00
**Usage:**
2025-02-24 08:03:37 -06:00
2025-01-24 13:04:43 -08:00
` ``bash
goose run --instructions plan.md
` ``
2025-02-24 08:03:37 -06:00
---
2025-01-24 13:04:43 -08:00
2025-02-24 08:03:37 -06:00
### agents
2025-02-18 10:29:03 -08:00
2025-02-24 08:03:37 -06:00
Used to show the available implementations of the agent loop itself
2025-01-24 13:04:43 -08:00
**Usage:**
2025-02-24 08:03:37 -06:00
2025-01-24 13:04:43 -08:00
` ``bash
2025-02-24 08:03:37 -06:00
goose agents
` ``