chatgpt.nvim

For Azure deployments, you must specify the URL base, engine, and API type. This can be done via configuration options (using executable commands) or environment variables.

Using Configuration Options

Use the following keys in your setup() call. Each must be an executable command that returns the corresponding value:

• api_type_cmd (e.g., echo azure)
• azure_api_base_cmd (e.g., echo https://{resource}.openai.azure.com)
• azure_api_engine_cmd (e.g., echo chat)
• azure_api_version_cmd (e.g., echo 2023-05-15)

Using Environment Variables

• $OPENAI_API_TYPE
• $OPENAI_API_BASE
• $OPENAI_API_AZURE_ENGINE
• $OPENAI_API_AZURE_VERSION

local config = {
  api_host_cmd = 'echo -n ""',
  api_key_cmd = 'pass azure-openai-key',
  api_type_cmd = 'echo azure',
  azure_api_base_cmd = 'echo https://{your-resource-name}.openai.azure.com',
  azure_api_engine_cmd = 'echo chat',
  azure_api_version_cmd = 'echo 2023-05-15'
}

require("chatgpt").setup(config)

To integrate ChatGPT commands into which-key.nvim, use the following configuration structure to map common actions like grammar correction, translation, and code optimization:

c = {
  name = "ChatGPT",
    c = { "<cmd>ChatGPT<CR>", "ChatGPT" },
    e = { "<cmd>ChatGPTEditWithInstruction<CR>", "Edit with instruction", mode = { "n", "v" } },
    g = { "<cmd>ChatGPTRun grammar_correction<CR>", "Grammar Correction", mode = { "n", "v" } },
    t = { "<cmd>ChatGPTRun translate<CR>", "Translate", mode = { "n", "v" } },
    k = { "<cmd>ChatGPTRun keywords<CR>", "Keywords", mode = { "n", "v" } },
    d = { "<cmd>ChatGPTRun docstring<CR>", "Docstring", mode = { "n", "v" } },
    a = { "<cmd>ChatGPTRun add_tests<CR>", "Add Tests", mode = { "n", "v" } },
    o = { "<cmd>ChatGPTRun optimize_code<CR>", "Optimize Code", mode = { "n", "v" } },
    s = { "<cmd>ChatGPTRun summarize<CR>", "Summarize", mode = { "n", "v" } },
    f = { "<cmd>ChatGPTRun fix_bugs<CR>", "Fix Bugs", mode = { "n", "v" } },
    x = { "<cmd>ChatGPTRun explain_code<CR>", "Explain Code", mode = { "n", "v" } },
    r = { "<cmd>ChatGPTRun roxygen_edit<CR>", "Roxygen Edit", mode = { "n", "v" } },
    l = { "<cmd>ChatGPTRun code_readability_analysis<CR>", "Code Readability Analysis", mode = { "n", "v" } },
  },

You can define custom actions using a JSON file. The path to this file can be configured via the actions_paths field.

An action requires a type (chat, completion, or edit), a strategy (replace, display, append, or edit), and optional args.

Template Variables:

• {{input}}: The selected text
• {{filetype}}: Neovim filetype
• {{filepath}}: Relative path to the file
• {{argument}}: Provided on the command line
• {{diagnostic}}: LSP diagnostic under cursor ([SEVERITY] message (line N))
• {{diagnostics}}: All LSP diagnostics in selection (Line N [SEVERITY]: message)

Strategies:

• edit: (Chat type only) Shows output side-by-side with input for further editing.
• display: Shows output in a float window.
• append: Modifies the text directly in the buffer by adding to it.
• replace: Modifies the text directly in the buffer by replacing it.

{
  "action_name": {
    "type": "chat",
    "opts": {
      "template": "A template using possible variables",
      "strategy": "replace",
      "params": {
        "model": "gpt-5-mini",
        "stop": [
          "```"
        ]
      }
    },
    "args": {
      "argument": {
          "type": "strig",
          "optional": "true",
          "default": "some value"
      }
    }
  }
}

When using :ChatGPT or :ChatGPTEditWithInstructions, use the following keybindings within the interactive window:

Submitting and Closing:

• <C-Enter> / <Enter>: Submit prompt
• q: Close chat window
• <C-c>: Stop generating response

Navigation:

• ]m / [m: Next/previous message
• ]c / [c: Next/previous code block
• <C-u> / <C-d>: Scroll up/down
• <Tab>: Cycle between windows

Toggles (g prefix):

• gs: Toggle settings panel (read-only)
• gh: Toggle help panel
• gp: Toggle sessions panel
• gr: Toggle system role window
• gm: Toggle message role (user/assistant)
• gl: Cycle layout modes (center/right)
• gn: Start new session
• gd: Draft message (add without sending)

Actions:

• y: Copy code block at cursor
• Y: Copy entire last answer
• d: Delete selected message
• e: Edit selected message
• r: Rename session (in sessions panel)
• za: Toggle fold for code block
• @: Trigger context autocomplete (LSP, project, file, git diff)

Edit Window specific:

• <C-y>: Accept changes
• <C-d>: Toggle diff view
• <C-i>: Use response as input