# Neovim Plugin > **Status**: In Development - The plugin code has been created but is not yet published. Installation requires cloning from the repository. The Apogee Neovim plugin provides native Lua integration for security scanning Solidity smart contracts. ## Requirements - Neovim 0.8.0 or later - 0xapogee-cli installed - Lua support (built into Neovim) ## Installation ### Using lazy.nvim ```lua { '0xapogee/0xapogee-nvim', ft = 'solidity', config = function() require('0xapogee').setup({ api_key = os.getenv('APOGEE_API_KEY'), }) end, } ``` ### Using packer.nvim ```lua use { '0xapogee/0xapogee-nvim', ft = 'solidity', config = function() require('0xapogee').setup({ api_key = os.getenv('APOGEE_API_KEY'), }) end, } ``` ### Using vim-plug ```vim Plug '0xapogee/0xapogee-nvim' " In init.vim after plug#end(): lua << EOF require('0xapogee').setup({ api_key = os.getenv('APOGEE_API_KEY'), }) EOF ``` ## Configuration ### Full Configuration Example ```lua require('0xapogee').setup({ -- Required: Your API key api_key = os.getenv('APOGEE_API_KEY'), -- Optional: Path to CLI (default: auto-detect) cli_path = nil, -- Optional: Scan when saving files scan_on_save = true, -- Optional: Show virtual text diagnostics virtual_text = true, -- Optional: Show signs in sign column signs = true, -- Optional: Filter by severity severity_filter = { 'critical', 'high', 'medium' }, -- Optional: Diagnostic namespace namespace = '0xapogee', -- Optional: Sign definitions signs_config = { critical = { text = '', texthl = 'DiagnosticSignError' }, high = { text = '', texthl = 'DiagnosticSignError' }, medium = { text = '', texthl = 'DiagnosticSignWarn' }, low = { text = '', texthl = 'DiagnosticSignInfo' }, info = { text = '', texthl = 'DiagnosticSignHint' }, }, -- Optional: Virtual text prefix virtual_text_prefix = ' ', }) ``` ### Environment Variables ```bash # Add to your shell profile (.bashrc, .zshrc, etc.) export APOGEE_API_KEY="your-api-key-here" ``` ## Commands | Command | Description | |---------|-------------| | `:ApogeeScan` | Scan current buffer | | `:ApogeeScanFile {path}` | Scan specific file | | `:ApogeeClear` | Clear all diagnostics | | `:ApogeeQuickfix` | Populate quickfix list | | `:ApogeeLoclist` | Populate location list | | `:ApogeeInfo` | Show plugin info | ## Keybindings Add to your Neovim config: ```lua -- Scan current file vim.keymap.set('n', 'bs', ':ApogeeScan', { desc = 'Apogee Scan' }) -- Clear diagnostics vim.keymap.set('n', 'bc', ':ApogeeClear', { desc = 'Apogee Clear' }) -- Open quickfix vim.keymap.set('n', 'bq', ':ApogeeQuickfix', { desc = 'Apogee Quickfix' }) ``` ## Diagnostics The plugin uses Neovim's built-in diagnostics system (`vim.diagnostic`). ### Viewing Diagnostics ```lua -- Show diagnostics in floating window vim.keymap.set('n', 'd', vim.diagnostic.open_float, { desc = 'Show Diagnostic' }) -- Go to next diagnostic vim.keymap.set('n', ']d', vim.diagnostic.goto_next, { desc = 'Next Diagnostic' }) -- Go to previous diagnostic vim.keymap.set('n', '[d', vim.diagnostic.goto_prev, { desc = 'Previous Diagnostic' }) ``` ### Diagnostic Severity Mapping | Apogee | Neovim | |-------------|--------| | Critical | ERROR | | High | ERROR | | Medium | WARN | | Low | INFO | | Info | HINT | ## Telescope Integration If you use Telescope, add this to your config: ```lua -- Search Apogee diagnostics with Telescope vim.keymap.set('n', 'bd', function() require('telescope.builtin').diagnostics({ namespace = vim.api.nvim_get_namespaces()['0xapogee'], }) end, { desc = 'Apogee Diagnostics' }) ``` ## Trouble.nvim Integration Diagnostics automatically appear in trouble.nvim: ```lua { 'folke/trouble.nvim', config = function() require('trouble').setup() end, } ``` Use `:Trouble diagnostics` to see all issues. ## Lualine Integration Show scan status in your statusline: ```lua require('lualine').setup({ sections = { lualine_x = { { function() local count = #vim.diagnostic.get(0, { namespace = vim.api.nvim_get_namespaces()['0xapogee'], }) if count > 0 then return ' ' .. count end return '' end, color = { fg = '#f38ba8' }, }, }, }, }) ``` ## Vim 8+ / ALE Integration For Vim 8+ users, use ALE instead: ```vim " .vimrc or init.vim let g:ale_linters = { \ 'solidity': ['0xapogee'], \} " Optional: Only run on save let g:ale_lint_on_save = 1 let g:ale_lint_on_text_changed = 'never' let g:ale_lint_on_insert_leave = 0 ``` ## Troubleshooting ### "Module '0xapogee' not found" 1. Verify plugin is installed: `:Lazy check` or `:PackerStatus` 2. Check plugin path is in runtime path: `:echo &rtp` 3. Reinstall the plugin ### "CLI not found" 1. Verify CLI is in PATH: `!0xapogee --version` 2. Set explicit path in config: `cli_path = '/path/to/0xapogee'` 3. Restart Neovim ### No Diagnostics Appearing 1. Check file has `.sol` extension 2. Verify diagnostics enabled: `:lua print(vim.diagnostic.is_enabled())` 3. Check for errors: `:messages` 4. Run manual scan: `:ApogeeScan` ### Performance Issues 1. Disable scan_on_save for large files 2. Use manual scanning with `:ApogeeScan` 3. Filter to show only critical/high severities ## API Reference ### Lua API ```lua local 0xapogee = require('0xapogee') -- Scan current buffer 0xapogee.scan() -- Scan specific file 0xapogee.scan_file('/path/to/contract.sol') -- Clear diagnostics 0xapogee.clear() -- Get current scan results local results = 0xapogee.get_results() -- Check if scanning local scanning = 0xapogee.is_scanning() ``` ## Related Documentation - [CLI Installation](/integrations/cli/cli-overview) - [CLI Configuration](/integrations/cli/cli-configuration) - [IDE Integration Overview](/integrations/ide/)