Skip to content

Commit cea5b18

Browse files
authored
docs: fix vim.pack instructions (#3036)
1 parent 48c6ae0 commit cea5b18

2 files changed

Lines changed: 19 additions & 15 deletions

File tree

doc/codecompanion.txt

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
*codecompanion.txt* For NVIM v0.11 Last change: 2026 April 09
1+
*codecompanion.txt*
2+
For NVIM v0.11 Last change: 2026 April 15
23

34
==============================================================================
45
Table of Contents *codecompanion-table-of-contents*
@@ -493,9 +494,9 @@ use a rich prompt input field complete with |codecompanion--editor-context|.
493494
Save with `:w` to send the prompt to the agent, or `:w!` to send and
494495
auto-submit it.
495496

496-
Adding `!` to the command (e.g. `:CodeCompanionCLI! <prompt>`) will
497-
auto-submit the prompt and keep your cursor in the current buffer. You can also
498-
specify which agent to use with `:CodeCompanionCLI agent=<agent name>`.
497+
Adding `!` to the command (e.g. `:CodeCompanionCLI! <prompt>`) will auto-submit
498+
the prompt and keep your cursor in the current buffer. You can also specify
499+
which agent to use with `:CodeCompanionCLI agent=<agent name>`.
499500

500501

501502
INLINE ~
@@ -887,7 +888,7 @@ CURRENT LIMITATIONS *codecompanion-acp-current-limitations*
887888
`terminal/output`, `terminal/release`, etc.) are not implemented. CodeCompanion
888889
doesn’t advertise terminal capabilities to agents.
889890
- **Agent Plan Rendering**: Plan
890-
<https://agentclientprotocol.com/protocol/agent-plan> updates from agents are
891+
<https://agentclientprotocol.com/protocol/agent-plan> updates from agents are
891892
received and logged, but they’re not currently rendered in the chat buffer
892893
UI.
893894
- **Audio Content**: Audio can’t be sent or received
@@ -1436,7 +1437,7 @@ The configuration for both types of adapters is exactly the same, however they
14361437
sit within their own tables (`adapters.http.*` and `adapters.acp.*`) and have
14371438
different options available. HTTP adapters use `models` to allow users to
14381439
select the specific LLM they’d like to interact with. ACP adapters use
1439-
`commands` to allow users to customize their interaction with agents (e.g.
1440+
`commands` to allow users to customize their interaction with agents (e.g.
14401441
enabling `yolo` mode). As there is a lot of shared functionality between the
14411442
two adapters, it is recommend that you read this page alongside the ACP one.
14421443

@@ -1492,7 +1493,7 @@ the adapter’s URL, headers, parameters and other fields at runtime.
14921493
<https://github.com/olimorris/codecompanion.nvim/discussions/601>
14931494
Supported `env` value types: - **Plain environment variable name (string)**: if
14941495
the value is the name of an environment variable that has already been set
1495-
(e.g. `"HOME"` or `"GEMINI_API_KEY"`), the plugin will read the value. -
1496+
(e.g. `"HOME"` or `"GEMINI_API_KEY"`), the plugin will read the value. -
14961497
**Command (string prefixed with cmd:)**: any value that starts with `cmd:` will
14971498
be executed via the shell. Example: `"cmd:op read
14981499
op://personal/Gemini/credential --no-newline"`. - **Function**: you can provide
@@ -4328,7 +4329,7 @@ message to the LLM.
43284329

43294330
[!IMPORTANT] With the exception of `#{buffer}` and `#{buffers}`, editor context
43304331
captures a point-in-time snapshot when your message is sent. If the underlying
4331-
data changes (e.g. new diagnostics, a different quickfix list), simply use the
4332+
data changes (e.g. new diagnostics, a different quickfix list), simply use the
43324333
context again in a new message to share the latest state.
43334334

43344335
#BUFFER ~
@@ -5104,7 +5105,7 @@ LIST OF EVENTS ~
51045105
The events that are fired from within the plugin are:
51055106

51065107
- `CodeCompanionACPConnected` - Fired after the ACP connection is authenticated and ready to use
5107-
- `CodeCompanionACPSessionPre` - Fired after ACP authentication completes but before a new session is established; allows subscribers to modify the connection (e.g. inject MCP servers) synchronously
5108+
- `CodeCompanionACPSessionPre` - Fired after ACP authentication completes but before a new session is established; allows subscribers to modify the connection (e.g. inject MCP servers) synchronously
51085109
- `CodeCompanionACPSessionPost` - Fired after a new ACP session has been established
51095110
- `CodeCompanionChatACPModeChanged` - Fired after the ACP mode has been changed in the chat
51105111
- `CodeCompanionACPChatRestored` - Fired after an ACP session has been restored
@@ -5116,7 +5117,7 @@ The events that are fired from within the plugin are:
51165117
- `CodeCompanionChatDone` - Fired after a chat has received the response
51175118
- `CodeCompanionChatStopped` - Fired after a chat has been stopped
51185119
- `CodeCompanionChatCleared` - Fired after a chat has been cleared
5119-
- `CodeCompanionChatRestored` - Fired after a chat has been restored to an editable state (e.g. when `on_before_submit` prevents submission)
5120+
- `CodeCompanionChatRestored` - Fired after a chat has been restored to an editable state (e.g. when `on_before_submit` prevents submission)
51205121
- `CodeCompanionChatAdapter` - Fired after the adapter has been set in the chat
51215122
- `CodeCompanionChatModel` - Fired after the model has been set in the chat
51225123
- `CodeCompanionCLICreated` - Fired after a CLI buffer has been created for the first time
@@ -5313,6 +5314,9 @@ If your prompt library entries have an `alias` defined then you can invoke them
53135314
using a slash command. In the cmd line `:CodeCompanion /<alias>` or `/<alias>`
53145315
if you’re in the chat buffer.
53155316

5317+
When invoked this way, any tools declared on the prompt are added to the
5318+
current chat buffer before the prompt content is inserted.
5319+
53165320

53175321
USER INTERFACE *codecompanion-usage-user-interface*
53185322

@@ -7512,7 +7516,7 @@ tool to function. In the case of Anthropic, we insert additional headers.
75127516
<
75137517

75147518
Some adapter tools can be a `hybrid` in terms of their implementation. That is,
7515-
they’re an adapter tool that requires a client-side component (i.e. a
7519+
they’re an adapter tool that requires a client-side component (i.e. a
75167520
built-in tool). This is the case for the
75177521
|codecompanion-usage-chat-buffer-agents-tools-memory| tool from Anthropic. To
75187522
allow for this, ensure that the tool definition in `available_tools` has

doc/installation.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,12 @@ The plugin can be installed with the plugin manager of your choice. It is recomm
2727
::: code-group
2828

2929
```lua [vim.pack]
30-
vim.pack.add("https://www.github.com/nvim-lua/plenary.nvim")
31-
vim.pack.add("https://github.com/nvim-treesitter/nvim-treesitter")
32-
vim.pack.add({
30+
vim.pack.add({ "https://www.github.com/nvim-lua/plenary.nvim" })
31+
vim.pack.add({ "https://github.com/nvim-treesitter/nvim-treesitter" })
32+
vim.pack.add({ {
3333
src = "https://www.github.com/olimorris/codecompanion.nvim",
3434
version = vim.version.range("^19.0.0")
35-
})
35+
} })
3636

3737
-- Somewhere in your config
3838
require("codecompanion").setup()

0 commit comments

Comments
 (0)