Skip to content

lyuwen/claude-code-vim-skills

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Claude Code Vim Skills

A comprehensive Claude Code plugin providing expert assistance for NeoVim and Vim users. Get help with everything from basic Vim commands to advanced NeoVim features like LSP, Tree-sitter, and Lua scripting.

Features

Note: This is a skill-only plugin focused on providing expert knowledge and guidance. It does not include slash commands, agents, or hooks - just the comprehensive NeoVim/Vim skill that activates automatically when you ask related questions.

  • Comprehensive Coverage: From basic Vim motions to advanced NeoVim configuration
  • Smart Routing: Automatically loads specialized knowledge based on your question
  • Always Up-to-Date: Fetches live documentation from NeoVim's GitHub repository
  • Progressive Context Loading: Only loads what's needed for your specific question

What This Plugin Helps With

  • Basic Vim Commands: Motions, text objects, visual mode, macros, registers, marks
  • LSP Setup: Language server configuration for Python, TypeScript, Rust, Go, and more
  • Lua Scripting: Understanding vim.opt, vim.api, vim.fn, and writing plugins
  • Tree-sitter: Parser installation, query syntax, custom highlighting
  • Plugin Management: lazy.nvim, packer, vim-plug setup and configuration
  • Configuration: Organizing init.lua, performance optimization, modular configs
  • API & Automation: Floating windows, extmarks, virtual text, job control

Installation

From Claude Code Marketplace

claude plugin install claude-code-vim-skills

From Local Directory

# Clone or download this repository
git clone https://github.com/yourusername/claude-code-vim-skills.git

# Install the plugin
claude plugin install ./claude-code-vim-skills

Manual Installation

Copy the plugin directory to your Claude Code plugins directory:

# macOS/Linux
cp -r claude-code-vim-skills ~/.claude/plugins/

# Or use symlink for development
ln -s /path/to/claude-code-vim-skills ~/.claude/plugins/claude-code-vim-skills

Usage

The plugin provides a single /neovim skill that automatically activates when you ask NeoVim or Vim related questions.

Example Questions

Basic Configuration:

How do I set soft tabs to 2 spaces?
How do I resize splits?
How do I create keybindings?

LSP Setup:

How do I set up LSP for Python?
How do I configure diagnostics?
What are the default LSP keybindings?

Lua Scripting:

What's the difference between vim.opt and vim.o?
How do I create autocommands in Lua?
How do I write a NeoVim plugin?

Tree-sitter:

How do I install Tree-sitter parsers?
How do I write a Tree-sitter query?
How do I debug syntax highlighting?

Plugin Management:

How do I install plugins with lazy.nvim?
What's the best fuzzy finder plugin?
How do I lazy-load plugins?

Advanced Topics:

How do I create a floating window?
How do I add virtual text?
How do I organize my init.lua?

Manual Invocation

You can also explicitly invoke the skill:

/neovim How do I set up LSP for Rust?

How It Works

The plugin uses a three-level architecture for efficient context management:

  1. Quick Answers: Common questions (tabs, splits, keybindings) answered directly
  2. Reference Modules: Advanced topics load specialized guidance on-demand
  3. Live Documentation: Fetches latest NeoVim docs from GitHub as needed

Reference Modules

The skill includes 7 specialized reference modules:

  • vim-basics.md - Fundamental Vim commands and concepts
  • lsp.md - Language Server Protocol setup and troubleshooting
  • lua.md - Lua scripting and NeoVim API
  • treesitter.md - Tree-sitter integration and queries
  • plugins.md - Plugin managers and popular plugins
  • config.md - Configuration organization and best practices
  • api.md - NeoVim API, floating windows, extmarks

Architecture

claude-code-vim-skills/
├── .claude-plugin/
│   └── plugin.json          # Plugin manifest
└── skills/
    └── neovim/              # Main skill
        ├── SKILL.md         # Entry point with quick reference
        └── references/      # Specialized modules
            ├── vim-basics.md
            ├── lsp.md
            ├── lua.md
            ├── treesitter.md
            ├── plugins.md
            ├── config.md
            └── api.md

Development

Running Tests

python3 tests/test_skills.py

Tests verify:

  • Skill structure and completeness
  • Documentation references
  • Routing logic
  • Realistic user scenarios

Contributing

Contributions are welcome! To add new reference modules or improve existing ones:

  1. Keep modules focused and concise (100-200 lines)
  2. List relevant NeoVim documentation files
  3. Provide answer structure templates
  4. Include troubleshooting patterns
  5. Run tests to ensure everything passes

Documentation

  • CLAUDE.md - Detailed architecture and design documentation
  • tests/ - Test suite validating skill structure

License

MIT License - see LICENSE file for details

Author

Lyuwen Fu (fulvwen@gmail.com)

Version

0.0.1 - Initial release

Keywords

neovim, vim, editor, configuration, lsp, treesitter, lua, plugins

About

An expert that help you with using and configuring Vim/NeoVim

Resources

License

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages