mirror of
https://github.com/aljazceru/goose.git
synced 2025-12-24 01:24:28 +01:00
79 lines
1.4 KiB
Markdown
79 lines
1.4 KiB
Markdown
# Goose CLI Commands
|
|
|
|
Goose provides a command-line interface (CLI) with various commands to manage sessions, toolkits, and more. Below is a list of the available commands and their descriptions:
|
|
|
|
## Goose CLI
|
|
|
|
### `version`
|
|
|
|
**Usage:**
|
|
```sh
|
|
goose version
|
|
```
|
|
|
|
Lists the version of Goose and any associated plugins.
|
|
|
|
### `session`
|
|
|
|
#### `start`
|
|
|
|
**Usage:**
|
|
```sh
|
|
goose session start [--profile PROFILE] [--log-level [DEBUG|INFO|WARNING|ERROR|CRITICAL]] [--tracing]
|
|
```
|
|
|
|
Starts a new Goose session.
|
|
|
|
If you want to enable locally hosted Langfuse tracing, pass the --tracing flag after starting your local Langfuse server as outlined in the [Contributing Guide's][contributing] Development guidelines.
|
|
|
|
#### `resume`
|
|
|
|
**Usage:**
|
|
```sh
|
|
goose session resume [NAME] [--profile PROFILE]
|
|
```
|
|
|
|
Resumes an existing Goose session.
|
|
|
|
#### `run`
|
|
|
|
Goose can run one off plans:
|
|
|
|
**Usage:**
|
|
```sh
|
|
goose run plan.md
|
|
```
|
|
|
|
It will run this plan, or sequence of tasks, to completion as a one shot task.
|
|
|
|
#### `list`
|
|
|
|
**Usage:**
|
|
```sh
|
|
goose session list
|
|
```
|
|
|
|
Lists all Goose sessions.
|
|
|
|
#### `clear`
|
|
|
|
**Usage:**
|
|
```sh
|
|
goose session clear [--keep KEEP]
|
|
```
|
|
|
|
Deletes old Goose sessions, keeping the most recent ones as specified by the `--keep` option.
|
|
|
|
### `toolkit`
|
|
|
|
#### `list`
|
|
|
|
**Usage:**
|
|
```sh
|
|
goose toolkit list
|
|
```
|
|
|
|
Lists all available toolkits with their descriptions.
|
|
|
|
[contributing]: https://block.github.io/goose/contributing.html
|