Skip to content

Commit 1d01c5e

Browse files
authored
docs: fix preset prompts example (#3038)
1 parent cea5b18 commit 1d01c5e

2 files changed

Lines changed: 25 additions & 6 deletions

File tree

doc/codecompanion.txt

Lines changed: 24 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ FEATURES *codecompanion-welcome-features*
8080
- Copilot Chat <https://github.com/features/copilot> meets Zed AI <https://zed.dev/blog/zed-ai>, in Neovim
8181
- Integrates Neovim with LLMs and Agents in the CLI
8282
- Support for LLMs from Anthropic, Copilot, GitHub Models, DeepSeek, Gemini, Mistral AI, Novita, Ollama, OpenAI, Azure OpenAI, HuggingFace and xAI out of the box (or bring your own!)
83-
- Support for Agent Client Protocol <https://agentclientprotocol.com/overview/introduction>, enabling coding with agents like Augment Code <https://docs.augmentcode.com/cli/overview>, Cagent <https://github.com/docker/cagent> from Docker, Claude Code <https://docs.anthropic.com/en/docs/claude-code/overview>, Cline CLI <https://docs.cline.bot/home>, Codex <https://openai.com/codex>, Copilot CLI <https://github.com/features/copilot/cli>, Gemini CLI <https://github.com/google-gemini/gemini-cli>, Goose <https://block.github.io/goose/>, Cursor CLI <https://cursor.com/docs/cli/overview>, Kimi CLI <https://github.com/MoonshotAI/kimi-cli>, Kiro <https://kiro.dev/cli/>, Mistral Vibe <https://github.com/mistralai/mistral-vibe> and OpenCode <https://opencode.ai>
83+
- Support for Agent Client Protocol <https://agentclientprotocol.com/overview/introduction>, enabling coding with agents like Augment Code <https://docs.augmentcode.com/cli/overview>, Cagent <https://github.com/docker/cagent> from Docker, Claude Code <https://docs.anthropic.com/en/docs/claude-code/overview>, Cline CLI <https://docs.cline.bot/home>, Codex <https://openai.com/codex>, Copilot CLI <https://github.com/features/copilot/cli>, Gemini CLI <https://github.com/google-gemini/gemini-cli>, Goose <https://block.github.io/goose/>, Cursor CLI <https://cursor.com/docs/cli/overview>, Kilo Code <https://kilo.ai>, Kimi CLI <https://github.com/MoonshotAI/kimi-cli>, Kiro <https://kiro.dev/cli/>, Mistral Vibe <https://github.com/mistralai/mistral-vibe> and OpenCode <https://opencode.ai>
8484
- User contributed and supported |codecompanion-configuration-adapters-http-community-adapters|
8585
- Support for |codecompanion-model-context-protocol|
8686
- |codecompanion-usage-inline.html|, code creation and refactoring
@@ -118,12 +118,13 @@ agents. Out of the box, the plugin supports:
118118
- Cline CLI (`cline_cli`)
119119
- Codex (`codex`) - Requires an API key
120120
- Copilot (`copilot`) - Requires a token which is created via `:Copilot setup` in Copilot.vim <https://github.com/github/copilot.vim>
121+
- DeepSeek (`deepseek`) - Requires an API key
122+
- Gemini (`gemini`) - Requires an API key
121123
- Gemini CLI (`gemini_cli`) - Requires an API key or a Gemini Pro subscription
122124
- GitHub Models (`githubmodels`) - Requires `gh` <https://github.com/cli/cli> to be installed and logged in
123125
- Goose (`goose`) - Requires an API key
124-
- DeepSeek (`deepseek`) - Requires an API key
125-
- Gemini (`gemini`) - Requires an API key
126126
- HuggingFace (`huggingface`) - Requires an API key
127+
- Kilo Code (`kilocode`) - Requires an API key
127128
- Kimi CLI (`kimi_cli`) - Requires an API key
128129
- Mistral AI (`mistral`) - Requires an API key or a Le Chat Pro subscription
129130
- Novita (`novita`) - Requires an API key
@@ -1374,6 +1375,24 @@ install Goose CLI. Then ensure that in your chat buffer you select the `goose`
13741375
adapter.
13751376

13761377

1378+
SETUP: KILO CODE ~
1379+
1380+
To use Kilo Code <https://kilo.ai> in CodeCompanion, ensure you’ve followed
1381+
their documentation to install
1382+
<https://kilo.ai/docs/getting-started/installing#cli> and configure
1383+
<https://kilo.ai/docs/getting-started/setup-authentication#cli> it. Then ensure
1384+
that in your chat buffer you select the `kilocode` adapter.
1385+
1386+
You can specify a custom model in your `~/.config/kilo/kilo.json` file:
1387+
1388+
>json
1389+
{
1390+
"$schema": "https://kilo.ai/config.json",
1391+
"model": "kilo/kilo-auto/free",
1392+
}
1393+
<
1394+
1395+
13771396
SETUP: KIMI CLI ~
13781397

13791398
Install Kimi CLI
@@ -3440,7 +3459,7 @@ The fastest way to copy an LLM’s code output is with `gy`. This will yank the
34403459
nearest codeblock.
34413460

34423461

3443-
APPLYING AN LLM€�S EDITS TO A BUFFER OR FILE ~
3462+
APPLYING AN LLMS EDITS TO A BUFFER OR FILE ~
34443463

34453464
The |codecompanion-usage-chat-buffer-agents-tools-files| tool, combined with
34463465
the |codecompanion-usage-chat-buffer-editor-context.html-buffer| editor context
@@ -5608,7 +5627,7 @@ These handlers manage tool/function calling:
56085627
as a great reference to understand how they’re working with the output of the
56095628
API
56105629

5611-
OPENAI€�S API OUTPUT
5630+
OPENAIS API OUTPUT
56125631

56135632
If we reference the OpenAI documentation
56145633
<https://platform.openai.com/docs/guides/text-generation/chat-completions-api>

doc/configuration/prompt-library.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -881,7 +881,7 @@ require("codecompanion").setup({
881881
display = {
882882
action_palette = {
883883
opts = {
884-
show_prompt_library_builtins = false,
884+
show_preset_prompts = false,
885885
}
886886
},
887887
},

0 commit comments

Comments
 (0)