summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMartin Bielik <martin.bielik@instea.sk>2024-12-17 21:09:53 +0100
committerMartin Bielik <martin.bielik@instea.sk>2024-12-17 21:09:53 +0100
commitdda1a41e00499ac9fd304bb87a1f521afa0fef1d (patch)
tree91720c60482a1107fed31a4a2b5c0b676088a7b1 /README.md
parent93cd92aa0bba2ac34df3b25b124790434a0cd8b0 (diff)
downloadvim-ai-dda1a41e00499ac9fd304bb87a1f521afa0fef1d.tar.gz
new utility commands
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 20 insertions, 6 deletions
diff --git a/README.md b/README.md
index 1970b54..448c3b3 100644
--- a/README.md
+++ b/README.md
@@ -77,15 +77,18 @@ git clone https://github.com/madox2/vim-ai.git ~/.local/share/nvim/site/pack/plu
To use an AI command, type the command followed by an instruction prompt. You can also combine it with a visual selection. Here is a brief overview of available commands:
```
-========= Basic AI commands =========
+=========== Basic AI commands ============
-:AI complete text
-:AIEdit edit text
-:AIChat continue or open new chat
+:AI complete text
+:AIEdit edit text
+:AIChat continue or open new chat
-============= Utilities =============
+=============== Utilities ================
-:AIRedo repeat last AI command
+:AIRedo repeat last AI command
+:AIUtilRolesOpen open role config file
+:AIUtilDebugOn turn on debug logging
+:AIUtilDebugOff turn off debug logging
:help vim-ai
```
@@ -400,6 +403,17 @@ let g:vim_ai_chat = {
" - setting max tokens to 0 will exclude it from the OpenAI API request parameters, it is
" unclear/undocumented what it exactly does, but it seems to resolve issues when the model
" hits token limit, which respond with `OpenAI: HTTPError 400`
+
+
+" custom roles file location
+let g:vim_ai_roles_config_file = s:plugin_root . "/roles-example.ini"
+
+" custom token file location
+let g:vim_ai_token_file_path = "~/.config/openai.token"
+
+" debug settings
+let g:vim_ai_debug = 0
+let g:vim_ai_debug_log_file = "/tmp/vim_ai_debug.log"
```
### Using custom API