Skip to content

v1.0.0

Choose a tag to compare

View all tags
@ralphmodales ralphmodales released this 24 Feb 07:24
· 8 commits to master since this release
v1.0.0
4709c23

helperAI v1.0.0 - Initial Release

A Neovim plugin that seamlessly integrates Exa API search capabilities directly into your editor. Never leave Neovim to search for documentation or references again!

🌟 Key Features

  • Visual Mode Search Integration: Highlight text and press <leader>s to instantly search
  • Floating Results Window: Clean, syntax-highlighted results appear in a non-intrusive floating window
  • Smart Result Ranking: Results are ranked by relevance and content quality
  • Animated Results Display: Smooth, line-by-line animation of search results
  • Syntax Highlighting: Custom highlight groups for better readability
    • Titles in blue (#7aa2f7)
    • Descriptions in green (#9ece6a)
    • URLs in purple with underline (#bb9af7)
    • Search terms highlighted in results (#3b4261 background)

🔧 Requirements

  • Neovim 0.10 or higher
  • Python 3.x
  • Python packages: exa_py, python-dotenv
  • Exa API key

📦 Installation

Using Lazy.nvim

{
  "ralphmodales/helperAI",
  config = function()
    require("helperAI").setup()
  end,
}

Manual Setup Required

  1. Create the HelperAI config directory:
mkdir -p ~/.config/nvim/helperAI
  1. Copy search.py to the config directory:
cp ~/.local/share/nvim/lazy/helperAI/search.py ~/.config/nvim/helperAI/
  1. Set up your Exa API key:
cp ~/.local/share/nvim/lazy/helperAI/.env.example ~/.config/nvim/helperAI/.env
# Edit .env and add your API key

🎨 Configuration

Default configuration with customization options:

require("helperAI").setup({
  keymap = "<leader>s"  -- Change this to your preferred keybinding
})

🐛 Bug Fixes

  • None (Initial Release)

📝 Notes

  • This is the initial stable release of HelperAI
  • Tested with Neovim 0.10.0 and Python 3.8+
  • Currently supports single-query searches only

🚧 Known Limitations

  • Maximum of 5 results per search
  • Requires valid Exa API key
  • Search descriptions limited to 200 characters

🔜 Planned Features

  • Configurable number of results
  • Custom highlight groups
  • Asynchronous result fetching
  • Result caching
  • Multiple search provider support

For full documentation and setup instructions, please see the README.md.

Report bugs or suggest features in the issue tracker.

Assets 2
Loading