navi-cli v1.0.9

Navi - AI Debugger in Terminal

Navi is your intelligent debugging companion that effortlessly tackles errors encountered while running Node.js applications. Seamlessly integrated into your workflow, Navi provides debugging suggestions directly in the Terminal, harnessing the power of OpenAI.

Installation

To use Navi, an OpenAI API key is required.

1. Install Navi globally:

npm install -g navi-cli

2. Ensure Navi is running:

navi

Getting Started

Choose your preferred method to start using Navi:

Option 1: Script Integration (Recommended)

Add Navi to your scripts in package.json:

"scripts": {
  "debug": "navi -d [YOUR_BUILD_COMMAND]"
}

Run:

npm run debug

Option 2: Manual Command

After a failed command, run:

navi -d [YOUR_BUILD_COMMAND]

Ensure your Node version is greater than 18.18, as older versions may encounter issues with node:fs libraries.

Supported Projects

Navi currently supports Node.js projects, providing assistance in debugging both JavaScript and TypeScript files. Stay tuned as we expand support for more projects in the future.

Use Cases

• Receive suggestions to resolve build errors
• Fix configuration issues
• Get guidance on upgrading deprecated packages

Upcoming Features

• Slack Integration: Navi will automatically suggest fixes shared by teammates on Slack.
• Notion & Google Docs Integration: Leverage content from knowledge bases to aid in debugging.

Demo Video

Feel free to open issues on our Github repo if you have any questions or encounter problems.

Happy debugging with Navi!