Skip to content

Commit

Permalink
add cli commands
Browse files Browse the repository at this point in the history
  • Loading branch information
lily-de committed Sep 17, 2024
1 parent 8b4ef5f commit db2bb74
Show file tree
Hide file tree
Showing 2 changed files with 64 additions and 0 deletions.
63 changes: 63 additions & 0 deletions docs/docs/cli.md
Original file line number Diff line number Diff line change
@@ -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.
1 change: 1 addition & 0 deletions docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -98,4 +98,5 @@ nav:
- 'Configuration': configuration.md
- 'Contributing': contributing.md
- 'Toolkits': toolkits.md
- 'CLI Commands': cli.md
- 'Tips': tips.md

0 comments on commit db2bb74

Please sign in to comment.