Skip to content

Commit 3ee1a96

Browse files
chore(doc): auto generate docs
1 parent cf4f7a5 commit 3ee1a96

File tree

1 file changed

+28
-26
lines changed

1 file changed

+28
-26
lines changed

doc/CopilotChat.txt

Lines changed: 28 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*CopilotChat.txt* For NVIM v0.8.0 Last change: 2025 October 01
1+
*CopilotChat.txt* For NVIM v0.8.0 Last change: 2025 October 06
22

33
==============================================================================
44
Table of Contents *CopilotChat-table-of-contents*
@@ -145,13 +145,13 @@ EXAMPLES *CopilotChat-examples*
145145

146146
# Sticky prompt that persists
147147

148-
> #buffer:current
148+
> #buffer:active
149149
> You are a helpful coding assistant
150150
<
151151

152-
When you use `@copilot`, the LLM can call functions like `glob`, `file`,
153-
`gitdiff` etc. You’ll see the proposed function call and can approve/reject
154-
it before execution.
152+
When you use `@copilot`, the LLM can call functions like `bash`, `edit`,
153+
`file`, `glob`, `grep`, `gitdiff` etc. You’ll see the proposed function call
154+
and can approve/reject it before execution.
155155

156156

157157
==============================================================================
@@ -183,7 +183,6 @@ CHAT KEY MAPPINGS *CopilotChat-chat-key-mappings*
183183
<C-l> <C-l> Reset and clear the chat window
184184
<C-s> <CR> Submit the current prompt
185185
- grr Toggle sticky prompt for line under cursor
186-
- grx Clear all sticky prompts in prompt
187186
<C-y> <C-y> Accept nearest diff
188187
- gj Jump to section of nearest diff
189188
- gqa Add all answers from chat to quickfix list
@@ -206,37 +205,40 @@ PREDEFINED FUNCTIONS *CopilotChat-predefined-functions*
206205

207206
All predefined functions belong to the `copilot` group.
208207

209-
------------------------------------------------------------------------------
210-
Function Description Example Usage
211-
------------- ----------------------------------------- ----------------------
212-
buffer Retrieves content from a specific buffer #buffer
208+
-------------------------------------------------------------------------------------
209+
Function Type Description Example Usage
210+
----------- ---------- ----------------------------------------- --------------------
211+
bash Tool Executes a bash command and returns @copilot only
212+
output
213213

214-
buffers Fetches content from multiple buffers #buffers:visible
214+
buffer Resource Retrieves content from buffer(s) with #buffer:active
215+
diagnostics
215216

216-
diagnostics Collects code diagnostics (errors, #diagnostics:current
217-
warnings)
217+
clipboard Resource Provides access to system clipboard #clipboard
218+
content
218219

219-
file Reads content from a specified file path #file:path/to/file
220+
edit Tool Applies a unified diff to a file @copilot only
220221

221-
gitdiff Retrieves git diff information #gitdiff:staged
222+
file Resource Reads content from a specified file path #file:path/to/file
222223

223-
gitstatus Retrieves git status information #gitstatus
224+
gitdiff Resource Retrieves git diff information #gitdiff:staged
224225

225-
glob Lists filenames matching a pattern in #glob:**/*.lua
226-
workspace
226+
glob Resource Lists filenames matching a pattern in #glob:**/*.lua
227+
workspace
227228

228-
grep Searches for a pattern across files in #grep:TODO
229-
workspace
229+
grep Resource Searches for a pattern across files in #grep:TODO
230+
workspace
230231

231-
quickfix Includes content of files in quickfix #quickfix
232-
list
232+
selection Resource Includes the current visual selection #selection
233+
with diagnostics
233234

234-
register Provides access to specified Vim register #register:+
235+
url Resource Fetches content from a specified URL #url:https://...
236+
-------------------------------------------------------------------------------------
237+
**Type Legend:**
235238

236-
selection Includes the current visual selection #selection
239+
- **Resource**: Can be used manually via `#function` syntax
240+
- **Tool**: Can only be called by LLM via `@copilot` (for safety/complexity reasons)
237241

238-
url Fetches content from a specified URL #url:https://...
239-
------------------------------------------------------------------------------
240242

241243
PREDEFINED PROMPTS *CopilotChat-predefined-prompts*
242244

0 commit comments

Comments
 (0)