https://github.com/nitintf/navi
Navi : AI-Powered Shell Guide
https://github.com/nitintf/navi
ai cli golang
Last synced: 5 months ago
JSON representation
Navi : AI-Powered Shell Guide
- Host: GitHub
- URL: https://github.com/nitintf/navi
- Owner: nitintf
- License: mit
- Created: 2024-03-24T10:23:06.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-31T00:58:27.000Z (about 2 years ago)
- Last Synced: 2024-06-21T08:20:36.597Z (about 2 years ago)
- Topics: ai, cli, golang
- Language: Go
- Homepage: https://navi.nitinp.dev
- Size: 38.1 KB
- Stars: 18
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Navi: AI-Powered Shell Guide
"Navi" means "guide" in Hindi, and that's exactly what this tool aims to be. Navi is a command-line tool that utilizes the Gemini API to leverage artificial intelligence in generating shell commands based on your prompts. It simplifies your workflow by understanding your intent and providing the necessary commands to achieve your tasks.
https://github.com/nitintf/navi/assets/55453926/407c41cb-0eb7-4362-a7db-65b224feb5ea
## Usage
```shell
Navi - Your AI-powered Shell Guide
Usage:
navi [flags]
navi [command]
Examples:
navi "List all files in the current directory."
Available Commands:
completion Generate the autocompletion script for the specified shell
explain Explain - Understand your shell commands
help Help about any command
Flags:
-h, --help help for navi
Use "navi [command] --help" for more information about a command.
```
## Commands
### 1. navi
The `navi` command takes a string as an argument and generates a shell command based on that string.
Example:
```shell
$ navi "list all files`
$ >> ls -a
```
### 2. navi explain
The `navi explain` command also takes a string (shell command) as an argument, and explains the functionality of a given shell command.
Example:
```shell
$ navi explain "ls -a`
$ Explanation >>
the command explanation
```
## Installation
You can install Navi using the `go install` command:
```shell
go install github.com/nitintf/navi
```
After installation, don't forget to export your Gemini API key:
```shell
export GEMINI_API_KEY="..."
```
You can obtain your Gemini API key from the [Gemini API Management page](https://aistudio.google.com/app/apikey).
## Vim integration
### Plugin load and installation
Edit `navi.vim` to set `g:NaviBin` to your custom binary location. Optionally, change the preferred key combination (defaults to ``).
In Vim, you simply have to `:source navi.vim`.
However, if you want the plugin to be persistent, make it load when Vim starts: copy `navi.vim` to any directory present in your runtime path (`:echo &runtimepath`). Restart Vim. Verify if the script is loaded with `:scriptnames`.
### Usage
In Normal Mode, press your preferred key combination (or by default) to pass your current line to `Navi`. In Visual Mode, you may select more lines.
## Caution
While Navi uses AI to generate shell commands, it's important to understand that AI isn't perfect. Always review the generated commands before executing them, especially if you're working in a production environment or dealing with sensitive data. Navi is a tool designed to assist you, but it doesn't replace good judgment and understanding of shell commands.
## Contribution
Contributions to Navi are very welcome! If you have a feature request, bug report, or proposal for code refactoring, please feel free to open an issue or submit a pull request.
This thing only supports Gemini for the moment, but it could be easily updated to support other models using Replicate, Ollama, etc. [Pull requests welcome](https://github.com/nitintf/navi/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc)!
## License
MIT