mirror of
https://github.com/aljazceru/goose.git
synced 2025-12-18 14:44:21 +01:00
1c9a7c0b05
Co-authored-by: Michael Neale <michael.neale@gmail.com> Co-authored-by: Wendy Tang <wendytang@squareup.com> Co-authored-by: Jarrod Sibbison <72240382+jsibbison-square@users.noreply.github.com> Co-authored-by: Alex Hancock <alex.hancock@example.com> Co-authored-by: Alex Hancock <alexhancock@block.xyz> Co-authored-by: Lifei Zhou <lifei@squareup.com> Co-authored-by: Wes <141185334+wesrblock@users.noreply.github.com> Co-authored-by: Max Novich <maksymstepanenko1990@gmail.com> Co-authored-by: Zaki Ali <zaki@squareup.com> Co-authored-by: Salman Mohammed <smohammed@squareup.com> Co-authored-by: Kalvin C <kalvinnchau@users.noreply.github.com> Co-authored-by: Alec Thomas <alec@swapoff.org> Co-authored-by: lily-de <119957291+lily-de@users.noreply.github.com> Co-authored-by: kalvinnchau <kalvin@block.xyz> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Rizel Scarlett <rizel@squareup.com> Co-authored-by: bwrage <bwrage@squareup.com> Co-authored-by: Kalvin Chau <kalvin@squareup.com> Co-authored-by: Alice Hau <110418948+ahau-square@users.noreply.github.com> Co-authored-by: Alistair Gray <ajgray@stripe.com> Co-authored-by: Nahiyan Khan <nahiyan.khan@gmail.com> Co-authored-by: Alex Hancock <alexhancock@squareup.com> Co-authored-by: Nahiyan Khan <nahiyan@squareup.com> Co-authored-by: marcelle <1852848+laanak08@users.noreply.github.com> Co-authored-by: Yingjie He <yingjiehe@block.xyz> Co-authored-by: Yingjie He <yingjiehe@squareup.com> Co-authored-by: Lily Delalande <ldelalande@block.xyz> Co-authored-by: Adewale Abati <acekyd01@gmail.com> Co-authored-by: Ebony Louis <ebony774@gmail.com> Co-authored-by: Angie Jones <jones.angie@gmail.com> Co-authored-by: Ebony Louis <55366651+EbonyLouis@users.noreply.github.com>
106 lines
2.0 KiB
Markdown
106 lines
2.0 KiB
Markdown
---
|
|
sidebar_position: 2
|
|
---
|
|
# 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
|
|
```
|
|
|
|
### version
|
|
|
|
Used to check the current Goose version you have installed
|
|
|
|
**Usage:**
|
|
```bash
|
|
goose --version
|
|
```
|
|
|
|
### agents
|
|
|
|
Used to list all available agents
|
|
|
|
**Usage:**
|
|
```bash
|
|
goose agents
|
|
```
|
|
|
|
### mcp
|
|
|
|
Run an enabled MCP server specified by `<name>` (e.g. 'Google Drive')
|
|
|
|
**Usage:**
|
|
```bash
|
|
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'`)
|
|
|
|
```bash
|
|
goose session --name <name>
|
|
```
|
|
|
|
- **`-r, --resume`**
|
|
|
|
Resume a previous session (last used or specified by `--name`)
|
|
|
|
```bash
|
|
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'`).
|
|
|
|
```bash
|
|
goose session --name <name> --with-extension <command>
|
|
```
|
|
|
|
- **`--with-builtin <NAME>`**
|
|
|
|
Starts the session with the specified [built-in extension](../configuration/managing-extensions.md#built-in-extensions) enabled. (e.g. 'developer')
|
|
|
|
```bash
|
|
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:**
|
|
```bash
|
|
goose run --instructions plan.md
|
|
```
|
|
|
|
### configure [options]
|
|
|
|
Configure Goose settings - providers, extensions, etc.
|
|
|
|
|
|
|
|
**Usage:**
|
|
```bash
|
|
goose configure'
|
|
``` |