buildwithnexus 0.8.10 → 0.8.11

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.
Files changed (4) hide show
  1. package/README.md +82 -71
  2. package/dist/bin.js +658 -479
  3. package/package.json +1 -1
  4. package/dist/deep-agents-bin.js +0 -340
package/README.md CHANGED
@@ -3,107 +3,118 @@
3
3
  [![npm version](https://img.shields.io/npm/v/buildwithnexus?style=flat-square&color=blue)](https://www.npmjs.com/package/buildwithnexus)
4
4
  [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square)](https://opensource.org/licenses/MIT)
5
5
 
6
- Launch an autonomous AI runtime with triple-nested VM isolation in one command.
7
-
8
- ## What It Does
9
-
10
- One command bootstraps a complete NEXUS instance:
11
-
12
- - **QEMU VM** running Ubuntu 24.04 (auto-installed if missing)
13
- - **Docker** inside the VM for isolated CLI sessions
14
- - **KVM** inside the VM for inner virtual machines (triple nesting)
15
- - **NEXUS server** running on port 4200 with full agent orchestration
16
- - **Cloudflare tunnel** (optional) for remote access
17
-
18
- All isolation is mandatory — NEXUS refuses to start unless it detects proper nesting (VM + Docker + KVM).
6
+ Interactive CLI for NEXUS — a 56-agent autonomous software engineering organization. Tell it what to build. It figures out the rest.
19
7
 
20
8
  ## Quick Start
21
9
 
22
10
  ```bash
23
- npx buildwithnexus init
11
+ npm install -g buildwithnexus
12
+ buildwithnexus
24
13
  ```
25
14
 
26
- This walks you through API key setup, VM resource allocation, and boots a fully provisioned NEXUS instance in ~10-25 minutes (first run). Subsequent starts take ~30 seconds.
27
-
28
- ## Requirements
15
+ On first run you'll be prompted to set your Anthropic API key. Keys are stored in `~/.buildwithnexus/.env.keys`.
29
16
 
30
- - **Node.js** >= 18
31
- - ~4GB RAM and ~20GB disk available for the VM
32
- - An Anthropic API key
17
+ ## What It Does
33
18
 
34
- ### macOS (ARM or Intel)
19
+ Launch an interactive shell with three execution modes:
35
20
 
36
- QEMU is installed automatically via Homebrew. If Homebrew isn't installed, get it at [brew.sh](https://brew.sh).
21
+ - **PLAN** — Break down your request into a reviewable step-by-step plan
22
+ - **BUILD** — Execute directly with live agent streaming
23
+ - **BRAINSTORM** — Free-form exploration with the NEXUS CPO streaming their reasoning
37
24
 
38
- ```bash
39
- npx buildwithnexus init
40
25
  ```
26
+ ╔════════════════════════════════════════════════════════════╗
27
+ ║ Nexus - Autonomous Agent Orchestration ║
28
+ ║ v0.8.10 ║
29
+ ╚════════════════════════════════════════════════════════════╝
41
30
 
42
- ### Linux (x64)
43
-
44
- QEMU is installed automatically via apt. Requires `sudo` access for package installation.
31
+ 📝 Task: Build a REST API for user authentication
45
32
 
46
- ```bash
47
- npx buildwithnexus init
33
+ Press Enter to use PLAN or choose a mode:
34
+ [1] PLAN design & break down steps
35
+ [2] BUILD execute with live streaming
36
+ [3] BRAINSTORM free-form explore & Q&A
48
37
  ```
49
38
 
50
- ### Windows (via WSL2)
51
-
52
- buildwithnexus requires WSL2 with an Ubuntu distribution. Native Windows is not supported.
53
-
54
- 1. Install WSL2: `wsl --install -d Ubuntu`
55
- 2. Open Ubuntu terminal
56
- 3. Install Node.js: `curl -fsSL https://deb.nodesource.com/setup_20.x | sudo -E bash - && sudo apt install -y nodejs`
57
- 4. Run: `npx buildwithnexus init`
39
+ ## Commands
58
40
 
59
- KVM nested virtualization must be enabled in your BIOS/UEFI settings.
41
+ ### Core (Python backend required)
60
42
 
61
- ## Commands
43
+ | Command | Description |
44
+ |---------|-------------|
45
+ | `buildwithnexus` | Launch interactive shell (PLAN/BUILD/BRAINSTORM) |
46
+ | `buildwithnexus da-init` | Set up API keys in `~/.buildwithnexus/.env.keys` |
47
+ | `buildwithnexus run <task>` | Run a task directly via the backend |
48
+ | `buildwithnexus brainstorm [idea]` | Brainstorm an idea with the NEXUS CPO |
49
+ | `buildwithnexus server` | Start the NEXUS Python backend server |
50
+ | `buildwithnexus da-status` | Check backend connectivity |
51
+ | `buildwithnexus doctor` | Run diagnostics (backend health + environment) |
52
+ | `buildwithnexus logs [-f]` | View server logs (stream with `-f`) |
53
+ | `buildwithnexus keys list` | List configured API keys |
54
+ | `buildwithnexus keys set <KEY_NAME>` | Set an API key |
55
+
56
+ ### Docker infrastructure (requires Docker + full NEXUS setup)
62
57
 
63
58
  | Command | Description |
64
59
  |---------|-------------|
65
- | `buildwithnexus init` | Full scaffolding + VM boot (10 phases) |
66
- | `buildwithnexus start` | Start an existing VM + server |
67
- | `buildwithnexus stop` | Graceful shutdown |
68
- | `buildwithnexus status` | VM / Docker / server / tunnel health |
69
- | `buildwithnexus doctor` | Diagnose QEMU, ports, SSH, disk |
70
- | `buildwithnexus logs [-f]` | Stream server logs |
71
- | `buildwithnexus update` | Upload latest release, rebuild, restart |
72
- | `buildwithnexus destroy [--force]` | Remove VM + all data |
73
- | `buildwithnexus keys set\|list` | Manage API keys |
74
- | `buildwithnexus ssh` | Direct SSH into the VM |
75
- | `buildwithnexus brainstorm [idea]` | Brainstorm an idea with the Chief of Staff |
60
+ | `buildwithnexus 99 [instruction]` | AI pair-programming via full NEXUS engine |
61
+ | `buildwithnexus start` | Start full NEXUS Docker services |
62
+ | `buildwithnexus stop` | Stop NEXUS Docker services |
63
+ | `buildwithnexus status [--json]` | Show Docker container health |
64
+ | `buildwithnexus dashboard` | Open the NEXUS dashboard at `localhost:4200/dashboard` |
65
+ | `buildwithnexus update` | Update to the latest version |
66
+ | `buildwithnexus destroy [--force]` | Remove NEXUS and all data |
67
+ | `buildwithnexus ssh` | Open SSH session into the sandbox |
76
68
 
77
69
  ## Architecture
78
70
 
79
71
  ```
80
- Host (your machine)
81
- └─ QEMU VM (Ubuntu 24.04)
82
- ├─ Docker (nexus-cli-sandbox)
83
- ├─ KVM / libvirt (inner VMs)
84
- └─ NEXUS server (:4200)
72
+ buildwithnexus CLI (TypeScript/Node.js)
73
+ │
74
+ │ SSE streaming
75
+ ▼
76
+ NEXUS Backend (Python FastAPI, port 4200)
77
+ │
78
+ ▼
79
+ LangGraph Runtime → 56-agent organization
80
+ • CPO (Opus) — brainstorm + strategy
81
+ • VP Engineering → 19 eng agents
82
+ • Product Management → 2 agents
83
+ • QA Team → 7 agents
84
+ • Security Team → 3 agents
85
+ • ML & Data → 6 agents
86
+ • Salesforce → 10 agents
87
+ • Documentation → 2 agents
88
+ • Consultant → 1 agent
85
89
  ```
86
90
 
87
- Port forwarding: SSH `localhost:2222`, NEXUS `localhost:4200`, HTTPS `localhost:8443`.
91
+ ## Requirements
92
+
93
+ - **Node.js** >= 18
94
+ - **Anthropic API key** (`sk-ant-...`) from [console.anthropic.com](https://console.anthropic.com)
95
+ - NEXUS backend running on `localhost:4200` (for PLAN/BUILD/BRAINSTORM modes)
96
+
97
+ Optional:
98
+ - OpenAI API key (o3 reasoning support)
99
+ - Google API key (Gemini multimodal support)
100
+
101
+ ## Environment Variables
102
+
103
+ | Variable | Default | Description |
104
+ |----------|---------|-------------|
105
+ | `ANTHROPIC_API_KEY` | — | Overrides stored key |
106
+ | `OPENAI_API_KEY` | — | Overrides stored key |
107
+ | `GOOGLE_API_KEY` | — | Overrides stored key |
108
+ | `BACKEND_URL` | `http://localhost:4200` | NEXUS backend address |
109
+ | `NEXUS_BACKEND_DIR` | `~/Projects/nexus` | Path to NEXUS backend for auto-start |
88
110
 
89
111
  ## Security
90
112
 
91
- Built-in DLP (Data Loss Prevention) layer protects every data path — zero dependencies, zero configuration:
92
-
93
- - **Input Sanitization** — YAML escaping and `shellCommand` tagged templates prevent injection
94
- - **Output Redaction** — API keys auto-redacted from logs, errors, and stdout
95
- - **Secret Validation** — format + injection character checks on all API keys at input
96
- - **File Integrity** — HMAC-SHA256 tamper detection on `.env.keys`
97
- - **Audit Trail** — every sensitive operation logged to `~/.buildwithnexus/audit.log`
98
- - **Environment Scrubbing** — child processes (QEMU, Docker, SSH) never inherit secrets
99
- - **SSH TOFU** — host key pinned on first connect, verified on every subsequent connection
100
- - SSH key-only auth (ed25519, no passwords)
101
- - UFW firewall (deny all, allow 22/80/443/4200)
102
- - auditd enabled (SOC 2 compliance)
103
- - Docker hardened (no-new-privileges, log rotation, cap-drop ALL)
104
113
  - API keys stored in `~/.buildwithnexus/.env.keys` with `0600` permissions
105
- - All directories created with `0700` permissions
106
- - Nesting enforcement guard prevents running outside VM isolation
114
+ - HMAC-SHA256 tamper detection on `.env.keys`
115
+ - Input sanitization and output redaction via DLP layer
116
+ - Backend URL validation before transmitting API keys
117
+ - Audit trail at `~/.buildwithnexus/audit.log`
107
118
 
108
119
  ## Links
109
120