@tosh99/navi-cli 0.1.1 → 0.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +52 -5
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,15 +1,62 @@
|
|
|
1
1
|
# navi-cli
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
A terminal AI chat CLI with multi-provider support. Ask questions, work with files, run code, and switch between AI models — all from your terminal.
|
|
4
|
+
|
|
5
|
+
## Requirements
|
|
6
|
+
|
|
7
|
+
[Bun](https://bun.sh) (v1.3.11 or higher)
|
|
8
|
+
|
|
9
|
+
## Installation
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
npm install -g @tosh99/navi-cli
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Configuration
|
|
16
|
+
|
|
17
|
+
Create a `navi.jsonc` file in your project directory:
|
|
18
|
+
|
|
19
|
+
```jsonc
|
|
20
|
+
{
|
|
21
|
+
"DEFAULT_MODEL_PROVIDER": "minimax",
|
|
22
|
+
"DEFAULT_MODEL": "MiniMax-M2.5",
|
|
23
|
+
"API_KEY_MINIMAX": "your-api-key"
|
|
24
|
+
}
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
### Available Providers
|
|
28
|
+
|
|
29
|
+
| Provider | Models |
|
|
30
|
+
|----------------|------------------------------------------|
|
|
31
|
+
| **OpenRouter** | Kimi K2.5, GPT-4o Mini, Claude 3.5 Haiku |
|
|
32
|
+
| **ZhipuAI** | GLM-4.5, GLM-4.5 Flash, GLM Z1 Flash |
|
|
33
|
+
| **MiniMax** | M2.7, M2.5 |
|
|
34
|
+
|
|
35
|
+
### Environment Variables
|
|
36
|
+
|
|
37
|
+
You can also set API keys via environment variables instead of the config file:
|
|
4
38
|
|
|
5
39
|
```bash
|
|
6
|
-
|
|
40
|
+
export OPENROUTER_API_KEY="your-key"
|
|
41
|
+
export ZHIPU_API_KEY="your-key"
|
|
42
|
+
export MINIMAX_API_KEY="your-key"
|
|
7
43
|
```
|
|
8
44
|
|
|
9
|
-
|
|
45
|
+
## Usage
|
|
10
46
|
|
|
11
47
|
```bash
|
|
12
|
-
|
|
48
|
+
navi
|
|
13
49
|
```
|
|
14
50
|
|
|
15
|
-
|
|
51
|
+
- Type your message and press **Enter** to send
|
|
52
|
+
- Type `/models` to switch AI models
|
|
53
|
+
- Use **↑/↓** arrows to navigate suggestions
|
|
54
|
+
- Press **Esc** to quit
|
|
55
|
+
|
|
56
|
+
## Quick Start
|
|
57
|
+
|
|
58
|
+
```bash
|
|
59
|
+
npm install -g @tosh99/navi-cli
|
|
60
|
+
echo '{"DEFAULT_MODEL_PROVIDER": "minimax", "DEFAULT_MODEL": "MiniMax-M2.5", "API_KEY_MINIMAX": "your-key"}' > navi.jsonc
|
|
61
|
+
navi
|
|
62
|
+
```
|