bridge-agent 0.1.0-beta.0 → 0.1.0-beta.2

package/README.md

@@ -1,6 +1,12 @@
 # bridge-agent
 
-Bridge local agent — connects your AI tools to Jerico
+Connects your local AI tools (Claude Code, Qwen CLI, Kimi, Codex, etc.) to Jerico — a browser-based multi-agent orchestration platform.
+
+## Requirements
+
+- Node.js >= 20
+- A running Jerico server
+- AI agents you want to use (each must be installed and authenticated)
 
 ## Installation
 
@@ -8,59 +14,117 @@ Bridge local agent — connects your AI tools to Jerico
 npm install -g bridge-agent
 ```
 
-## Usage
+## Quick Start
 
 ### 1. Authenticate
 
-Get a token from your Jerico server (Settings → Daemon Tokens), then:
+Get a daemon token from your Jerico server (**Settings → Daemon Tokens**), then:
 
 ```bash
 bridge-agent auth --server https://your-server.com --token YOUR_TOKEN
 ```
 
-Or with interactive browser flow:
+For interactive browser flow (opens your default browser):
 
 ```bash
 bridge-agent auth --server https://your-server.com
 ```
 
-### 2. Start the Daemon
+### 2. Start
 
 ```bash
 bridge-agent start
 ```
 
 The daemon will:
-- Connect to your Jerico server via WebSocket
-- Detect installed AI agents (Claude, Qwen, Kimi, etc.)
-- Allow spawning terminals from the web interface
+- Connect to the Jerico server via WebSocket
+- Auto-detect installed AI agents on your machine
+- Spawn PTY sessions for terminal emulation
+- Report usage metrics (Claude context window, 5h prompt quota)
+
+### 3. Done — open Jerico in your browser
+
+Your machine will appear in the Machines page. Spawn panels and orchestrate agents from the web UI.
+
+## Commands
+
+| Command | Description |
+|---|---|
+| `bridge-agent start` | Start the daemon (connects to server from config) |
+| `bridge-agent auth [options]` | Authenticate with a Jerico server |
+| `bridge-agent status` | Show current connection status and config |
+
+## Auth Options
+
+```
+--server, -s   Jerico server URL (required)
+--token, -t    Daemon token (skip browser flow)
+--no-browser   Print auth URL instead of opening browser
+```
+
+## Configuration
+
+Config is stored at `~/.bridge/config.json`:
+
+```json
+{
+  "server": "wss://your-server.com/ws/daemon",
+  "token": "brg_...",
+  "name": "my-machine"
+}
+```
 
-### 3. Check Status
+### Claude Quota Tracking
+
+Set your Claude tier in `~/.jerico/settings.json`:
+
+```json
+{
+  "claudeTier": "pro"
+}
+```
+
+Supported tiers: `free` (10 prompts/5h), `pro` (40), `max_5x` (200), `max_20x` (200)
+
+### MCP Server (Production)
+
+In production, set `BRIDGE_MCP_URL` to enable HTTP MCP transport:
 
 ```bash
-bridge-agent status
+BRIDGE_MCP_URL=https://your-server.com bridge-agent start
 ```
 
 ## Supported Agents
 
-- **Claude Code** (`claude`) - Requires `claude` CLI
-- **Qwen CLI** (`qwen`) - Requires `qwen` CLI  
-- **Kimi Code** (`kimi`) - Requires `kimi` CLI
-- **Codex CLI** (`codex`) - Requires `codex` CLI
-- **Gemini** (`gemini`) - Requires `gemini` CLI
-- **Ollama** (`ollama`) - Requires `ollama`
-- **Aider** (`aider`) - Requires `aider`
-- **Shell** (`sh`) - System shell (always available)
+| Agent | Key | Notes |
+|---|---|---|
+| Claude Code | `claude` | MCP + session support |
+| Qwen CLI | `qwen` | MCP + session support |
+| Kimi Code | `kimi` | MCP + session support |
+| Codex CLI | `codex` | MCP enabled |
+| Gemini | `gemini` | CLI only |
+| Ollama | `ollama` | CLI only |
+| Aider | `aider` | MCP enabled |
+| Shell | `sh` | Always available |
 
-## Configuration
+## Troubleshooting
 
-Config is stored in:
-- macOS/Linux: `~/.bridge/config.json` or `~/.jerico/settings.json`
+**Daemon not connecting?**
+```bash
+bridge-agent status
+# Check server URL and token are correct
+```
 
-## Requirements
+**Need to re-authenticate?**
+```bash
+bridge-agent auth --server https://your-server.com --token YOUR_NEW_TOKEN
+```
 
-- Node.js >= 20
-- For each AI agent: the respective CLI tool installed and authenticated
+**View logs:**
+The daemon outputs to stdout. Redirect to a file if needed:
+```bash
+bridge-agent start > ~/bridge-daemon.log 2>&1 &
+```
 
 ## License