diff --git a/docs/docs/cli.md b/docs/docs/cli.md new file mode 100644 index 000000000..5d27563c9 --- /dev/null +++ b/docs/docs/cli.md @@ -0,0 +1,63 @@ +# 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] [--plan PLAN] +``` + +Starts a new Goose session. + +#### `resume` + +**Usage:** +```sh + goose session resume [NAME] [--profile PROFILE] +``` + +Resumes an existing Goose session. + +#### `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. diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 4e4f09e05..edff5f820 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -98,4 +98,5 @@ nav: - 'Configuration': configuration.md - 'Contributing': contributing.md - 'Toolkits': toolkits.md + - 'CLI Commands': cli.md - 'Tips': tips.md