Skip to content

Commit ac1feb8

Browse files
committed
Update README.md
1 parent 09c2447 commit ac1feb8

File tree

1 file changed

+27
-2
lines changed

1 file changed

+27
-2
lines changed

README.md

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -257,9 +257,14 @@ For deep technical details, see [ARCHITECTURE.md](./ARCHITECTURE.md).
257257
terminal = {
258258
split_side = "right", -- "left" or "right"
259259
split_width_percentage = 0.30,
260-
provider = "auto", -- "auto", "snacks", "native", or custom provider table
260+
provider = "auto", -- "auto", "snacks", "native", "external", or custom provider table
261261
auto_close = true,
262262
snacks_win_opts = {}, -- Opts to pass to `Snacks.terminal.open()` - see Floating Window section below
263+
264+
-- Provider-specific options
265+
provider_opts = {
266+
external_terminal_cmd = nil, -- Command template for external terminal provider (e.g., "alacritty -e %s")
267+
},
263268
},
264269

265270
-- Diff Integration
@@ -440,7 +445,27 @@ For complete configuration options, see:
440445
- [Snacks.nvim Terminal Documentation](https://github.com/folke/snacks.nvim/blob/main/docs/terminal.md)
441446
- [Snacks.nvim Window Documentation](https://github.com/folke/snacks.nvim/blob/main/docs/win.md)
442447

443-
## Custom Terminal Providers
448+
## Terminal Providers
449+
450+
### External Terminal Provider
451+
452+
Run Claude Code in a separate terminal application outside of Neovim:
453+
454+
```lua
455+
{
456+
"coder/claudecode.nvim",
457+
opts = {
458+
terminal = {
459+
provider = "external",
460+
provider_opts = {
461+
external_terminal_cmd = "alacritty -e %s", -- Replace with your preferred terminal program. %s is replaced with claude command
462+
},
463+
},
464+
},
465+
}
466+
```
467+
468+
### Custom Terminal Providers
444469

445470
You can create custom terminal providers by passing a table with the required functions instead of a string provider name:
446471

0 commit comments

Comments
 (0)