🚀 Neovim - AI-Enhanced Code Editor¶

A comprehensive Neovim setup based on AstroNvim v5 with extensive AI integration, database tools, and modern development features.

📋 Table of Contents¶

• Overview
• Key Features
• Installation & Setup
• Key Bindings
• AI Tools
• Database Development
• Plugin Management
• Customization
• Troubleshooting

🎯 Overview¶

This Neovim configuration is built on AstroNvim v5, providing a modern, feature-rich development environment with:

• AI Integration: Multiple AI assistants for coding help
• Database Tools: Advanced SQL development with Snowflake support
• LSP Support: Language servers for multiple programming languages
• Modern UI: Beautiful interface with treesitter syntax highlighting
• Project Management: Seamless integration with tmux sessionizer

Base Framework¶

• AstroNvim v5: Modern Neovim distribution
• Lazy.nvim: Fast plugin manager
• Mason: LSP, formatter, and linter installer
• Treesitter: Advanced syntax highlighting

✨ Key Features¶

🤖 AI-Powered Development¶

• CodeCompanion: AI chat and inline assistance
• GitHub Copilot: Primary AI code completion with ergonomic keybindings
• Database AI: AI-powered SQL assistance
• Streamlined AI System: Simplified, conflict-free AI completion

🗄️ Database Development¶

• nvim-dbee: Advanced database explorer
• Snowflake Integration: MFA support and connection management
• SQL Completion: AI-powered SQL suggestions
• Query Execution: Run queries directly from editor

🛠️ Development Tools¶

• LSP Integration: Language servers for 20+ languages
• Debugging: DAP integration for multiple languages
• Testing: Integrated test runners
• Git Integration: Advanced git workflows
• File Management: Oil.nvim for file operations

🎨 UI & Experience¶

• Custom Dashboard: Branded startup screen
• Catppuccin Theme: Beautiful, consistent theming
• Status Line: Rich status information
• Notifications: Snacks.nvim for beautiful notifications

🚀 Installation & Setup¶

Prerequisites¶

# Install Neovim (latest stable)
brew install neovim

# Install required dependencies
brew install ripgrep fd fzf git

Configuration Installation¶

The configuration is automatically installed via the dotfiles setup:

# Via dotfiles installation
make stow-install

# Or manually symlink
ln -sf ~/.dotfiles/dotfiles/nvim/.config/nvim ~/.config/nvim

First Launch¶

1. Open Neovim: nvim
2. Plugin Installation: Plugins install automatically
3. LSP Setup: Run :Mason to install language servers
4. AI Setup: Configure API keys (see AI Tools section)

Post-Installation¶

# Install language servers
:Mason

# Update plugins
:Lazy sync

# Check health
:checkhealth

⌨️ Key Bindings¶

Leader Keys¶

• Leader: <Space>
• Local Leader: ,

Essential Shortcuts¶

AI Assistance¶

AI Completion (GitHub Copilot)¶

Zen Mode & Focus¶

Database Tools¶

File Operations¶

LSP & Code¶

Git Integration¶

🤖 AI Tools¶

CodeCompanion¶

Primary AI assistant for chat and inline help

Setup¶

1. API Key: Set your OpenAI API key

   export OPENAI_API_KEY="your-api-key"
   

2. Configuration: See dotfiles/nvim/.config/nvim/docs/CODECOMPANION_USAGE.md

Features¶

• Chat Interface: Full conversation with AI
• Inline Assistance: AI suggestions in code
• Code Actions: Context-aware AI actions
• Multiple Models: Support for different AI models

GitHub Copilot¶

Primary AI code completion with ergonomic keybindings

Setup¶

1. Install: Already configured in dotfiles
2. Authenticate: :Copilot auth
3. Enable: :Copilot enable

Ergonomic Keybindings¶

The keybindings are designed for comfortable typing flow: - Left hand: Holds Ctrl key - Right hand: Reaches for target keys - Tab: Smart accept or normal tab behavior

Key Features¶

• Smart Tab: Accepts suggestions when available, normal tab otherwise
• Multiple Accept Options: Full suggestion, word, or line
• Easy Navigation: Previous/next suggestions with bracket keys
• Quick Dismiss: Ctrl+Backspace for natural dismiss motion

Usage Commands¶

• Panel: <leader>cp to open Copilot panel
• Status: <leader>cs to check status
• Enable/Disable: <leader>ce / <leader>cd

🗄️ Database Development¶

nvim-dbee¶

Advanced database explorer and query tool

Features¶

• Connection Management: Save and manage database connections
• Query Execution: Run SQL queries directly from Neovim
• Result Viewing: Beautiful result display
• Snowflake Support: Special handling for Snowflake MFA

Setup¶

1. Open Database Explorer: <leader>Dd
2. Add Connection: Use the UI to add database connections
3. Save Connections: Connections are saved automatically

Snowflake Integration¶

• MFA Support: Handles Snowflake multi-factor authentication
• Auto-disable: Prevents auto-connection to avoid MFA prompts
• Manual Connection: Connect only when needed

Usage¶

-- Execute query with BB (visual mode or normal mode)
SELECT * FROM my_table LIMIT 10;

-- Use completion for table names and columns
-- AI assistance for complex queries

Database AI¶

• SQL Generation: AI-powered SQL query generation
• Query Optimization: AI suggestions for query improvements
• Schema Understanding: AI help with database schema

🔌 Plugin Management¶

Lazy.nvim¶

Modern plugin manager with lazy loading

Commands¶

:Lazy                 # Open plugin manager
:Lazy sync           # Update all plugins
:Lazy install        # Install missing plugins
:Lazy clean          # Remove unused plugins
:Lazy profile        # Profile startup time

Adding Plugins¶

1. Create Plugin File: Add to dotfiles/nvim/.config/nvim/lua/plugins/
2. Plugin Specification: Use Lazy.nvim format
3. Reload: Restart Neovim or :Lazy reload

Mason¶

LSP, formatter, and linter installer

Commands¶

:Mason               # Open Mason UI
:MasonInstall <tool> # Install specific tool
:MasonUpdate         # Update all tools
:MasonLog            # View installation logs

Installed Tools¶

• Language Servers: lua_ls, pyright, tsserver, rust_analyzer, etc.
• Formatters: prettier, stylua, black, rustfmt, etc.
• Linters: eslint, flake8, shellcheck, etc.
• Debuggers: debugpy, node-debug2, etc.

🎨 Customization¶

Adding Custom Keybindings¶

Edit dotfiles/nvim/.config/nvim/lua/plugins/astrocore.lua:

mappings = {
  n = {
    ["<leader>custom"] = { ":echo 'Custom command'<cr>", desc = "Custom action" },
  },
}

Custom Plugins¶

Create new file in dotfiles/nvim/.config/nvim/lua/plugins/:

-- custom-plugin.lua
return {
  "author/plugin-name",
  config = function()
    require("plugin-name").setup({
      -- configuration
    })
  end,
}

Theme Customization¶

Edit dotfiles/nvim/.config/nvim/lua/plugins/theme.lua:

-- Modify Catppuccin theme settings
opts = {
  flavour = "mocha", -- latte, frappe, macchiato, mocha
  -- custom colors and highlights
}

LSP Configuration¶

Edit dotfiles/nvim/.config/nvim/lua/plugins/astrolsp.lua:

-- Add custom LSP settings
config = {
  servers = {
    "new_language_server",
  },
}

🔧 Troubleshooting¶

Common Issues¶

Plugins Not Loading¶

# Check plugin status
:Lazy

# Reinstall plugins
:Lazy clean
:Lazy sync

# Check for errors
:messages

LSP Not Working¶

# Check LSP status
:LspInfo

# Install language server
:Mason

# Restart LSP
:LspRestart

AI Tools Not Responding¶

# Check API keys
:echo $OPENAI_API_KEY

# Check network connectivity
# Verify API key validity

# Check plugin status
:Lazy

Database Connection Issues¶

# Check dbee status
:DbeeLoadConnections

# Verify connection details
# Check network connectivity to database

# For Snowflake MFA issues
:DbeeRestoreSnowflake

Performance Issues¶

Slow Startup¶

# Profile startup time
:Lazy profile

# Disable unnecessary plugins
# Optimize plugin loading

High Memory Usage¶

# Check memory usage
:lua print(vim.fn.system("ps aux | grep nvim"))

# Disable heavy plugins if needed
# Reduce treesitter parsers

Configuration Debugging¶

Check Health¶

:checkhealth          # General health check
:checkhealth lazy     # Plugin manager health
:checkhealth lsp      # LSP health
:checkhealth treesitter # Treesitter health

View Configuration¶

:lua print(vim.inspect(require("lazy").plugins()))
:lua print(vim.inspect(vim.g))
:lua print(vim.inspect(vim.o))

📚 Advanced Features¶

Custom Commands¶

# Database helpers
:DbeeCreateExample    # Create example connections
:DbeeLoadConnections  # Load connections manually
:DbeeRestoreSnowflake # Restore Snowflake connections

# AI commands
:CodeCompanion        # Open AI chat
:CodeCompanionActions # Show AI actions

Automation¶

• Auto-save: Automatic file saving (configurable)
• Session Management: Integration with tmux sessions
• Project Detection: Automatic project-specific settings

Integration¶

• Tmux: Seamless tmux integration with sessionizer
• Git: Advanced git workflows with Lazygit
• Terminal: Integrated terminal with toggleterm
• File Manager: Oil.nvim for file operations

📖 Related Documentation¶

• AI Tools Setup
• Database Configuration
• Tmux Integration
• Troubleshooting Guide
• Plugin Configurations