-
-
Notifications
You must be signed in to change notification settings - Fork 135
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
6 changed files
with
56 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,26 @@ | ||
# Using the Action Palette | ||
|
||
<p> | ||
<img src="https://github.com/user-attachments/assets/0d427d6d-aa5f-405c-ba14-583830251740" /> | ||
</p> | ||
|
||
The _Action Palette_ has been designed to be your entry point for the many configuration options that CodeCompanion offers. It can be opened with `:CodeCompanionActions`. | ||
|
||
Once opened, the user can see plugin defined actions such as `Chat` and `Open Chats`. The latter, enabling the user to move between any open chat buffers. These can be turned off in the config by setting `display.action_palette.opts.show_default_actions = false`. | ||
|
||
## Default Prompts | ||
|
||
The plugin also defines a number of prompts in the form of the prompt library: | ||
|
||
- `Explain` - Explain how code in a buffer works | ||
- `Fix Code` - Fix the selected code | ||
- `Explain LSP Diagnostics` - Explain the LSP diagnostics for the selected code | ||
- `Unit Tests` - Generate unit tests for selected code | ||
- `Generate a Commit Message` - Generate a commit message | ||
|
||
> [!INFO] | ||
> These can also be called via the cmd line for example `:CodeCompanion /explain` | ||
The plugin also contains an example workflow, `Code Workflow`. See the [workflows section](/usage/workflows) for more information. | ||
|
||
The default prompts can be turned off by setting `display.action_palette.show_default_prompt_library = false`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,22 @@ | ||
# Using CodeCompanion | ||
|
||
Below are some ideas for how you can use the plugin to make your Neovim workflow more productive | ||
CodeCompanion continues to evolve with regular frequency. This page will endeavour to serve as focal point for providing useful productivity tips for the plugin. | ||
|
||
## Available Commands | ||
## Copying code from a chat buffer | ||
|
||
## Use the `@editor` Tool | ||
The fastest way to copy an LLM's code output is with `gy`. This will yank the nearest codeblock. | ||
|
||
## Automatically update a buffer | ||
|
||
The [editor](/usage/chat-buffer/agents#editor) tool enables an LLM to modify code in a Neovim buffer. This is especially useful if you do not wish to manually apply an LLM's suggestions yourself. Simply tag it in the chat buffer with `@editor`. | ||
|
||
## Run tests from the chat buffer | ||
|
||
The [cmd_runner](/usage/chat-buffer/agents#cmd-runner) tool enables an LLM to execute commands on your machine. This can be useful if you wish the LLM to run a test suite on your behalf and give insight on failing cases. | ||
|
||
## Quickly accessing a chat buffer | ||
|
||
The `:CodeCompanionChat Toggle` command will automically create a chat buffer if one doesn't exist, open the last chat buffer or hide the current chat buffer. It's the fastest way to navigate chat buffers. | ||
|
||
When in a chat buffer, you can cycle between other chat buffers with `{` or `}`. | ||
|
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,3 @@ | ||
# Using Workflows | ||
|
||
To be updated. |