@mmmbuto/nexuscrew 0.2.0 → 0.2.1

package/README.md

@@ -1,108 +1,121 @@
-# NexusCrew — tmux AI Cockpit
-
-**Mobile-first** web cockpit for AI CLI tools. Persistent sessions via tmux.
-
-## Features
-
-- **Persistent sessions** — tmux windows survive server restarts
-- **4 engines** — Claude Code, Codex CLI, Gemini CLI, Qwen Code
-- **Mobile-first** — Termux (Android) primary target, then Linux/Mac
-- **Zero native deps** — sql.js (WASM SQLite), no compilation needed
-- **Auth** — JWT with localhost auto-bypass
-- **Dark/Light theme** — CSS variables, instant toggle
-- **i18n** — 6 languages (en, it, es, ja, ru, zh)
-- **STT/TTS** — Speech-to-text (Web Speech API + OpenAI Whisper) + Read aloud
-- **File upload** — 50MB attachments
-- **Session dots** — Green (alive), Yellow (idle), Red (dead) tmux state
-- **Lane-aware models** — Native + Custom per engine
-- **Shell discovery** — Scans .zshrc, .bashrc, providers.zsh for aliases
-- **Remote hosts** — SSH to any machine
-- **SSE streaming** — Real-time AI output
-- **6 languages UI** — Auto-detects browser language
+# NexusCrew
+
+Mobile-first `tmux` cockpit for local and remote AI CLI sessions.
+
+NexusCrew is built for `Termux` and smartphone-first workflows, but also runs on Linux and macOS. It keeps CLI sessions alive inside `tmux`, exposes them through a web UI, and lets you switch between local and SSH hosts without reopening everything by hand.
+
+## Highlights
+
+- Persistent `tmux` sessions for Claude, Codex, Gemini and Qwen
+- Local + SSH host switching from one mobile-first UI
+- Remote streaming via `tmux capture-pane`
+- File and image attachments, including remote SSH staging
+- Local STT with `whisper.cpp`, browser fallback, system TTS
+- Dark/light theme
+- Installable web app shell with mobile icon/manifest
+- Termux-oriented CLI with setup, start, status and host management
 
 ## Install
 
 ```bash
 npm install -g @mmmbuto/nexuscrew
-nexuscrew init
+nexuscrew setup
 nexuscrew start
-# Open http://localhost:41820
 ```
 
-### Termux (Android)
+`nexuscrew start` runs the server in background, waits for health, and can open the browser for you.
+
+Default URL:
+
+```text
+http://localhost:41820
+```
+
+## Termux
+
+Recommended base packages:
 
 ```bash
-pkg install tmux nodejs
+pkg install nodejs tmux openssh termux-services
 npm install -g @mmmbuto/nexuscrew
-nexuscrew init
-nexuscrew start
+nexuscrew setup
 ```
 
-## Quick Start
+The setup wizard can also:
+
+- prepare `Termux:Boot`
+- create and enable the native `runit` service via `termux-services`
+- configure SSH hosts
+- prepare local STT checks for `whisper.cpp`
+
+## Core Commands
 
 ```bash
-nexuscrew init      # First-time setup
-nexuscrew start     # Start server + tmux
-nexuscrew status    # Check server + sessions
-nexuscrew attach    # Attach to tmux directly
-nexuscrew engines   # Discover AI CLIs
+nexuscrew setup
+nexuscrew start
+nexuscrew stop
+nexuscrew status
+nexuscrew attach
+nexuscrew sessions
+nexuscrew hosts list
+nexuscrew hosts add --name mybox --host example.com --user dag
+nexuscrew stt doctor
 ```
 
-## Architecture
+## How It Works
 
-```
-Browser/WebView ←SSE/REST→ Express :41820 ←tmux→ CLI AI processes
-                                    |
-                                sql.js DB (WASM)
-                                JWT Auth
+```text
+Browser/WebView  <->  Express API  <->  tmux session/windows  <->  AI CLI processes
+                                      |
+                                      +-> local machine
+                                      +-> SSH hosts
 ```
 
-Each AI session = one tmux window. Output captured via `tee`, streamed to UI via SSE.
+Each conversation runs in its own `tmux` window. Local sessions stream from log watchers; remote sessions stream from incremental pane capture.
 
 ## Configuration
 
-`~/.nexuscrew/config.json`:
-```json
-{
-  "port": 41820,
-  "tmuxSession": "nexuscrew",
-  "autoDiscovery": true
-}
+Main config:
+
+```text
+~/.nexuscrew/config.json
+```
+
+Host registry:
+
+```text
+~/.nexuscrew/hosts.json
 ```
 
-## Commands
+Important defaults include:
 
-| Command | Description |
-|---------|-------------|
-| `nexuscrew init` | First-time setup |
-| `nexuscrew start` | Start server + tmux |
-| `nexuscrew stop` | Stop server |
-| `nexuscrew status` | Server + tmux + hosts |
-| `nexuscrew engines` | Discover CLIs + aliases |
-| `nexuscrew sessions` | List tmux windows |
-| `nexuscrew attach` | Attach to tmux |
-| `nexuscrew config` | View/edit config |
-| `nexuscrew hosts add` | Add SSH host |
+- `server.port`
+- `tmuxSession`
+- `hosts.default`
+- `workspaces.default`
+- `stt.provider`
+- `termux.boot_start`
+- `termux.service_enabled`
 
-## API
+## Authentication
 
-Public: `/health`, `/api/v1/auth/login`, `/api/v1/models`, `/api/v1/runtimes`
-Protected (JWT/localhost): `/api/v1/send`, `/api/v1/sessions`, `/api/v1/upload`, `/api/v1/workspaces`
+Localhost use is optimized for local device workflows.
 
-Default login: `admin` / `admin` (change after first login)
+For remote or network exposure, review and configure authentication before relying on the instance outside localhost. Do not expose an unreviewed dev setup directly to the public internet.
 
 ## Development
 
 ```bash
 git clone https://github.com/DioNanos/nexuscrew
-cd nexuscrew && npm install
-cd frontend && npm install && npm run build && cd ..
+cd nexuscrew
+npm install
+npm run build
 npm run dev
 ```
 
 ## Related
 
-- [NexusCLI](https://www.npmjs.com/package/@mmmbuto/nexuscli) — PTY-based variant
+- [NexusCLI](https://www.npmjs.com/package/@mmmbuto/nexuscli) - PTY-based sibling project
 
 ## License