gemini/README.md

neovim-gemini

A Neovim plugin for interacting with the Google AI API (formerly Gemini). Get AI-powered assistance directly within your Neovim editor.

Requirements

• Neovim 0.8 or higher
• A Google AI API key (obtainable from https://makersuite.google.com/app/apikey)
• curl installed on your system

Installation

Use your favorite Neovim package manager. Here's how to install with Lazy.nvim:

{
  "your_username/neovim-gemini",
  config = function()
    require("gemini").setup()
  end,
}

Configuration

Set your API key using one of these methods:

1. Environment variable:

export GEMINI_API_KEY="your-api-key-here"

2. Neovim configuration:

-- In your init.lua
vim.g.gemini_api_key = "your-api-key-here"

Usage

The plugin provides three ways to interact with Gemini:

1. Command Mode:

:Gemini What is SOLID in software engineering?

2. Simple Query (default):

• Press <leader>gc to open an input prompt (mnemonic: 'gemini chat')
• Type your query and press Enter

3. Context-Aware Query:

• Press <leader>gs to open an input prompt (mnemonic: 'gemini sync')
• This will send your current buffer's content as context along with your query
• Useful for code-related questions about the file you're working on

Response Window

The AI response appears in a floating window. You can close it using:

• q key
• <Esc> key
• <Enter> key
• :q command

Features

• Floating window interface
• Non-blocking API calls
• Error handling and notifications
• Easy-to-use command and keymap interface
• Support for the latest Gemini 2.0 Flash model

Troubleshooting

If you encounter issues:

1. Verify your API key is correctly set:

:lua print(vim.g.gemini_api_key)

2. Check if curl is installed:

curl --version

3. Ensure you have billing set up in your Google Cloud project

License

This project is licensed under the ISC License. See the LICENSE file for details.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.