Skip to content

Commit

Permalink
docs: update CLI commands documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
bishoy-at-pieces committed Aug 12, 2024
1 parent b8362e7 commit 172b411
Showing 1 changed file with 27 additions and 1 deletion.
28 changes: 27 additions & 1 deletion docs/extensions-plugins/cli/commands.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ pieces list apps
```

#### List AI Models
Lists all accessible AI models.
Lists all accessible AI models, and open the list to change the model from in the `ask`

```bash
pieces list models
Expand Down Expand Up @@ -223,6 +223,26 @@ Switches the conversation and lists its messages. Check the `conversations` comm
pieces conversation x
```

### `Ask`

The ask command allows you to ask the Pieces Copilot a question. By default, it uses the GPT-3.5 model, but you can change the model using the `list models` command. You can also add relevant files and snippets to provide more context for your question.
The question that is asked in a new conversation to change the current conversation use the `conversation` command

```shell
pieces ask "your question" -f /file1 /file2 folder -s 1 2 3
```

- **"your question":** The question you want to ask the Pieces Copilot. It must be enclosed in quotes.
- **f /file1 /file2 folder: (Optional)** Paths to files or folders that are relevant to your question. You can specify multiple files or folders.
- **s 1 2 3: (Optional)** Indices of snippets that are relevant to your question. You can specify multiple snippet indices

### `change_model` (deprecated)
Change the model used in the ask command.

```bash
pieces change_model [MODEL_INDEX]
```

## Integration

### `commit`
Expand All @@ -238,6 +258,12 @@ You can also add the `-i` or `--issues` flags so the commit message will include
pieces commit -i
```

By adding the `-a` or the `--all` flags, All changes will be staged first, before generating the commiting messages

```shell
pieces commit -a
```

### `login`
Logs in to your Pieces account.

Expand Down

0 comments on commit 172b411

Please sign in to comment.