From 172b41167d06c744212393cd991f9d1fc5949a48 Mon Sep 17 00:00:00 2001 From: Bishoy-at-pieces Date: Mon, 12 Aug 2024 17:30:46 +0300 Subject: [PATCH 1/2] docs: update CLI commands documentation --- docs/extensions-plugins/cli/commands.mdx | 28 +++++++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) diff --git a/docs/extensions-plugins/cli/commands.mdx b/docs/extensions-plugins/cli/commands.mdx index 1c003c3d4..1de41d2f0 100644 --- a/docs/extensions-plugins/cli/commands.mdx +++ b/docs/extensions-plugins/cli/commands.mdx @@ -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 @@ -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` @@ -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. From d2f1bb4bfc8b31df07eef98844a3c671b9c35a0f Mon Sep 17 00:00:00 2001 From: Bishoy-at-pieces Date: Mon, 12 Aug 2024 21:26:19 +0300 Subject: [PATCH 2/2] add more descriptive description for the list command --- docs/extensions-plugins/cli/commands.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/extensions-plugins/cli/commands.mdx b/docs/extensions-plugins/cli/commands.mdx index 1de41d2f0..4f2606623 100644 --- a/docs/extensions-plugins/cli/commands.mdx +++ b/docs/extensions-plugins/cli/commands.mdx @@ -75,7 +75,7 @@ pieces list apps ``` #### List AI Models -Lists all accessible AI models, and open the list to change the model from in the `ask` +Lists all accessible AI models and opens the list to change the model to be used in the ask command. ```bash pieces list models @@ -226,7 +226,7 @@ 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 +The question that is asked, will generate 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