agentics-cli 0.1.4 → 0.1.6
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
ADDED
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
# Agentics CLI
|
|
2
|
+
|
|
3
|
+
A powerful AI inference CLI with multi-model support, voice capabilities, and agentic tool use.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install -g agentics-cli
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
Launch the interactive TUI:
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
agentics-cli
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
Or use the short alias:
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
ai
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
## Features
|
|
26
|
+
|
|
27
|
+
### Multi-Model Chat
|
|
28
|
+
Access 27+ AI models through a unified interface:
|
|
29
|
+
- **Odin** - Flagship model
|
|
30
|
+
- **Zeus** - Thinking/reasoning model
|
|
31
|
+
- **Sigma** - Fast general-purpose
|
|
32
|
+
- **Nitro** - Large context model
|
|
33
|
+
- **Lambda** - Coding specialist
|
|
34
|
+
- And many more...
|
|
35
|
+
|
|
36
|
+
### Voice Capabilities
|
|
37
|
+
- **Text-to-Speech** - Multiple voice options with adjustable speed
|
|
38
|
+
- **Speech-to-Text** - Real-time transcription via Whisper
|
|
39
|
+
- **Hands-Free Mode** - Continuous voice conversation with VAD and end-of-turn detection
|
|
40
|
+
|
|
41
|
+
### Agentic Tools
|
|
42
|
+
Enable agent mode for autonomous task execution:
|
|
43
|
+
- **Bash** - Execute shell commands
|
|
44
|
+
- **File Editor** - View, create, and edit files
|
|
45
|
+
- **Search** - Glob and grep for files and content
|
|
46
|
+
- **Web Search** - Search the internet
|
|
47
|
+
- **URL Fetch** - Read web pages
|
|
48
|
+
- **Python** - Execute Python code
|
|
49
|
+
- **Image Generation** - Create AI images
|
|
50
|
+
|
|
51
|
+
### Web Builder Mode
|
|
52
|
+
Specialized mode for building static HTML5 websites with automatic file management.
|
|
53
|
+
|
|
54
|
+
## Keyboard Shortcuts
|
|
55
|
+
|
|
56
|
+
| Key | Action |
|
|
57
|
+
|-----|--------|
|
|
58
|
+
| `Ctrl+O` | Open menu |
|
|
59
|
+
| `Ctrl+L` | Clear chat |
|
|
60
|
+
| `Ctrl+F` | File picker |
|
|
61
|
+
| `Ctrl+S` | Toggle speech output |
|
|
62
|
+
| `Ctrl+H` | Toggle hands-free mode |
|
|
63
|
+
| `Ctrl+W` | Toggle web builder mode |
|
|
64
|
+
| `Shift+Tab` | Toggle agent mode |
|
|
65
|
+
| `Ctrl+C` | Cancel/quit |
|
|
66
|
+
|
|
67
|
+
## Slash Commands
|
|
68
|
+
|
|
69
|
+
| Command | Description |
|
|
70
|
+
|---------|-------------|
|
|
71
|
+
| `/help` | Show help |
|
|
72
|
+
| `/clear` | Clear chat history |
|
|
73
|
+
| `/model <name>` | Switch AI model |
|
|
74
|
+
| `/image <name>` | Switch image model |
|
|
75
|
+
| `/auto` | Toggle auto-accept for tools |
|
|
76
|
+
| `/exit` | Exit the CLI |
|
|
77
|
+
|
|
78
|
+
## Configuration
|
|
79
|
+
|
|
80
|
+
Config files are stored in `~/.agentics/`:
|
|
81
|
+
|
|
82
|
+
- `credentials.json` - Authentication tokens
|
|
83
|
+
- `settings.json` - User preferences
|
|
84
|
+
- `AGENTICS.md` - Custom instructions for the AI
|
|
85
|
+
|
|
86
|
+
## Authentication
|
|
87
|
+
|
|
88
|
+
Login through the main `agentics` package or directly in the CLI when prompted. Your session is stored locally and shared between the main package and CLI.
|
|
89
|
+
|
|
90
|
+
## Requirements
|
|
91
|
+
|
|
92
|
+
- Node.js 16+
|
|
93
|
+
- Linux (x64, arm64) or Windows (x64)
|
|
94
|
+
- macOS support coming soon
|
|
95
|
+
|
|
96
|
+
## Links
|
|
97
|
+
|
|
98
|
+
- Website: https://agentics.co.za
|
|
99
|
+
- API Docs: https://api.agentics.co.za/docs
|
|
100
|
+
- Main Package: https://www.npmjs.com/package/agentics
|
|
101
|
+
|
|
102
|
+
## License
|
|
103
|
+
|
|
104
|
+
Proprietary - © Agentics (Pty) Ltd
|
|
Binary file
|
|
Binary file
|