Skip to content

docs: convert configuration examples to collapsible sections and add community extensions #93

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 35 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,8 @@ return {
}
```

### Alternative with Meta+, (Alt+,) Toggle
<details>
<summary>Alternative with Meta+, (Alt+,) Toggle</summary>

```lua
local toggle_key = "<M-,>" -- Alt/Meta + comma
Expand Down Expand Up @@ -235,7 +236,10 @@ return {
}
```

### Centered Floating Window with Custom Styling
</details>

<details>
<summary>Centered Floating Window with Custom Styling</summary>

```lua
require("claudecode").setup({
Expand All @@ -255,7 +259,10 @@ require("claudecode").setup({
})
```

### Multiple Key Binding Options
</details>

<details>
<summary>Multiple Key Binding Options</summary>

```lua
{
Expand Down Expand Up @@ -285,7 +292,10 @@ require("claudecode").setup({
}
```

### Window Position Variations
</details>

<details>
<summary>Window Position Variations</summary>

```lua
-- Bottom floating (like a drawer)
Expand Down Expand Up @@ -314,6 +324,8 @@ snacks_win_opts = {
}
```

</details>

For complete configuration options, see:

- [Snacks.nvim Terminal Documentation](https://github.com/folke/snacks.nvim/blob/main/docs/terminal.md)
Expand Down Expand Up @@ -433,6 +445,25 @@ require("claudecode").setup({

The custom provider will automatically fall back to the native provider if validation fails or `is_available()` returns false.

## Community Extensions

The following are third-party community extensions that complement claudecode.nvim. **These extensions are not affiliated with Coder and are maintained independently by community members.** We do not ensure that these extensions work correctly or provide support for them.

### 🔍 [claude-fzf.nvim](https://github.com/pittcat/claude-fzf.nvim)

Integrates fzf-lua's file selection with claudecode.nvim's context management:

- Batch file selection with fzf-lua multi-select
- Smart search integration with grep → Claude
- Tree-sitter based context extraction
- Support for files, buffers, git files

### 📚 [claude-fzf-history.nvim](https://github.com/pittcat/claude-fzf-history.nvim)

Provides convenient Claude interaction history management and access for enhanced workflow continuity.

> **Disclaimer**: These community extensions are developed and maintained by independent contributors. The authors and their extensions are not affiliated with Coder. Use at your own discretion and refer to their respective repositories for installation instructions, documentation, and support.

## Troubleshooting

- **Claude not connecting?** Check `:ClaudeCodeStatus` and verify lock file exists in `~/.claude/ide/` (or `$CLAUDE_CONFIG_DIR/ide/` if `CLAUDE_CONFIG_DIR` is set)
Expand Down