Skip to content

Commit 0c4edb8

Browse files
committed
Add nexa CLI documentation and update installation guides
- Added comprehensive nexa CLI section with terminal examples - Updated all installation methods (Homebrew, Linux, Docker) to mention nexa - Added nexa features: zero dependencies, cross-platform, Rust-powered - Updated roadmap to mark Rust CLI as completed - Enhanced installation sections with architecture support details nexa is the new Rust-based interactive CLI for NexaDB - think 'mysql' for MySQL, but 'nexa' for NexaDB. Zero dependencies, works everywhere.
1 parent 1c0a09c commit 0c4edb8

1 file changed

Lines changed: 69 additions & 15 deletions

File tree

README.md

Lines changed: 69 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -153,11 +153,21 @@ nexadb start
153153
# - Binary Protocol on port 6970 (10x faster!)
154154
# - JSON REST API on port 6969 (REST fallback)
155155
# - Admin Web UI on port 9999 (Web interface)
156+
# - Nexa CLI (interactive terminal) - ready to use!
156157

157158
# Access admin panel
158159
open http://localhost:9999
160+
161+
# Use interactive CLI
162+
nexa -u root -p
159163
```
160164

165+
**What gets installed:**
166+
-`nexadb` command - Start/stop server, manage services
167+
-`nexa` command - Interactive CLI terminal (Rust-based, zero dependencies)
168+
- ✅ Python server files and dependencies
169+
- ✅ Admin panel web interface
170+
161171
### Installation via Install Script (Linux/Ubuntu)
162172

163173
```bash
@@ -173,15 +183,28 @@ nexadb start
173183
# Access admin panel
174184
open http://localhost:9999
175185

186+
# Use interactive CLI
187+
nexa -u root -p
188+
176189
# Uninstall (if needed)
177190
curl -fsSL https://raw.githubusercontent.com/krishcdbry/nexadb/main/uninstall.sh | bash
178191
```
179192

193+
**What gets installed:**
194+
-`nexadb` command - Start/stop server, manage services
195+
-`nexa` command - Interactive CLI terminal (Rust-based, auto-detects architecture)
196+
- ✅ Python server files and dependencies
197+
- ✅ Admin panel web interface
198+
180199
**Supported Linux Distributions:**
181200
- Ubuntu/Debian (18.04+)
182201
- Fedora/RHEL/CentOS (7+)
183202
- Arch Linux/Manjaro
184203

204+
**Supported Architectures:**
205+
- x86_64 (Intel/AMD 64-bit)
206+
- aarch64 (ARM64 - Raspberry Pi, AWS Graviton, etc.)
207+
185208
### Installation via Docker (Windows, Mac, Linux)
186209

187210
```bash
@@ -209,15 +232,24 @@ docker stop nexadb
209232

210233
# Remove
211234
docker rm nexadb
235+
236+
# Use nexa CLI inside Docker
237+
docker exec -it nexadb nexa -u root -p
212238
```
213239

214240
**What you get:**
215241
- ✅ Works on Windows, Mac, Linux
216242
- ✅ Isolated environment
217243
- ✅ Persistent data volume
218244
- ✅ Auto-restart on reboot
245+
- ✅ Nexa CLI included (works inside container)
219246
- ✅ Easy updates: `docker pull krishcdbry/nexadb:latest`
220247

248+
**Supported Docker Platforms:**
249+
- Linux (x86_64, ARM64)
250+
- macOS (Intel, Apple Silicon)
251+
- Windows (WSL2)
252+
221253
### Cloud Deployment (Railway, Render, Fly.io)
222254

223255
**Deploy to Railway (1-Click):**
@@ -272,36 +304,57 @@ python3 nexadb_server.py
272304
open http://localhost:9999
273305
```
274306

275-
### Interactive CLI
307+
### Interactive CLI (Nexa)
308+
309+
**NEW: Rust-based CLI for blazing-fast performance!**
310+
311+
Nexa is a zero-dependency, standalone CLI built in Rust. Think `mysql` for MySQL, but `nexa` for NexaDB.
276312

277313
```bash
278-
# Start the interactive shell
279-
python3 nexadb_cli.py -u root -p
314+
# Start nexa interactive terminal (automatically installed with NexaDB)
315+
nexa -u root -p
280316
Password: ********
281317

282-
Connected to NexaDB v2.0.0
318+
Connected to NexaDB v2.0.0 (Binary Protocol: localhost:6970)
283319

284-
nexadb> USE movies
320+
nexa> collections
321+
✓ Found 2 collection(s):
322+
[1] movies
323+
[2] users
324+
325+
nexa> use movies
285326
✓ Switched to collection 'movies'
286327

287-
nexadb(movies)> CREATE {"title": "The Matrix", "year": 1999}
328+
nexa(movies)> insert {"title": "The Matrix", "year": 1999, "vector": [0.9, 0.15, 0.97, 0.5]}
288329
✓ Document created: doc_abc123
289330

290-
nexadb(movies)> QUERY {"year": {"$gte": 2000}}
331+
nexa(movies)> query {"year": {"$gte": 2000}}
291332
✓ Found 5 document(s)
292333

293-
nexadb(movies)> VECTOR_SEARCH [0.5, 0.2, 0.98, 0.5] 3 4
334+
nexa(movies)> vector_search [0.5, 0.2, 0.98, 0.5] 3 4
294335
✓ Found 3 similar document(s):
295-
[1] 98.91% match
296-
{
297-
"title": "Blade Runner 2049",
298-
"year": 2017
299-
}
336+
[1] 98.91% match - Blade Runner 2049
300337

301-
nexadb(movies)> EXIT
338+
nexa(movies)> count
339+
✓ Document count: 127
340+
341+
nexa(movies)> exit
302342
Goodbye! 👋
303343
```
304344

345+
**Nexa Features:**
346+
-**Zero dependencies** - Single standalone binary
347+
-**Blazing fast** - Written in Rust, uses MessagePack binary protocol
348+
-**Cross-platform** - Works on macOS, Linux, Windows
349+
-**Auto-installed** - Comes with Homebrew, Docker, and Linux installer
350+
-**Full-featured** - All commands: insert, read, update, delete, query, vector search, count
351+
-**History & completion** - Readline support with command history
352+
353+
**Also available: Python CLI** (for scripting):
354+
```bash
355+
python3 nexadb_cli.py -u root -p
356+
```
357+
305358
### 5-Minute Quick Start: Movie Semantic Search
306359

307360
Build a semantic search system in 5 minutes! This example shows how NexaDB's vector search finds similar movies by theme, not keywords.
@@ -889,7 +942,8 @@ python3 admin_server.py --port 9999 --data-dir ./nexadb_data
889942
- [x] Homebrew distribution (macOS)
890943
- [x] Linux install script (Ubuntu, Fedora, Arch)
891944
- [x] **Docker image** (Windows, Mac, Linux) 🐳
892-
- [x] **Interactive CLI** (`nexadb-cli -u root -p`) 💻
945+
- [x] **Interactive Python CLI** (`python3 nexadb_cli.py -u root -p`) 💻
946+
- [x] **Rust CLI** (`nexa -u root -p`) - Zero-dependency, cross-platform 🦀
893947
- [x] **Cloud deployment** (Railway, Render, Fly.io) ☁️
894948
- [x] Production-grade NexaClient with reconnection
895949

0 commit comments

Comments
 (0)