Skip to content

README.md

Latest commit

 

History

History
180 lines (129 loc) · 4.71 KB

README.md

File metadata and controls

180 lines (129 loc) · 4.71 KB
Raw
arrowcode

Multi-agent terminal coding harness — plan → questions → confirm → execute → accept.

  • Four agents (ORCH · FE · BE · QA) work in parallel, can spawn swarm workers, use 25+ tools, and support per-agent APIs/models.
arrowcode

Features

  • Gated harness: /plan → Q&A → /confirm → swarm execute → /accept
  • Dashboard TUI: 2×2 agents · plan · swarm map · files · diff · bus · timeline
  • Sessions: workspace .arrowcode-sessions/ (resume, memory, metrics)
  • Safety: path deny, secret scan, bash allowlist, dry-run, token budget, /undo
  • Perf: parallel read tools, prompt/file caches, fast context trim (/perf)
  • Packaging: defaults/ in repo; ~/.arrowcode only after install/setup

Requirements

  • Bun ≥ 1.1
    curl -fsSL https://bun.sh/install | bash
  • Git (recommended)
  • An OpenAI-compatible API key (default: NVIDIA NIM nvapi-...)

Install

One-liner (recommended)

Linux / macOS / WSL (install.sh)

curl -fsSL https://raw.githubusercontent.com/Chintanpatel24/arrowcode/main/install.sh | bash

Install + open API setup wizard:

curl -fsSL https://raw.githubusercontent.com/Chintanpatel24/arrowcode/main/install.sh | bash -s -- --setup

Windows PowerShell (install.ps1)

irm https://raw.githubusercontent.com/Chintanpatel24/arrowcode/main/install.ps1 | iex

Install + API setup wizard:

& ([scriptblock]::Create((irm https://raw.githubusercontent.com/Chintanpatel24/arrowcode/main/install.ps1))) -Setup

Or clone first, then:

git clone https://github.com/Chintanpatel24/arrowcode.git
cd arrowcode
.\install.ps1 -Setup

What the one-liners do:

  1. Install Bun if missing
  2. Clone/update ArrowCode
  3. bun install
  4. Seed ~/.arrowcode from defaults/
  5. Link arrowcode / ac onto your PATH

From a clone

git clone https://github.com/Chintanpatel24/arrowcode.git
cd arrowcode
chmod +x install.sh bin/arrowcode
./install.sh
# or without install script:
bun install
bun link          # optional global arrowcode / ac

Update

To instantly update ArrowCode from any directory, keeping your local changes preserved:

curl -fsSL https://raw.githubusercontent.com/Chintanpatel24/arrowcode/main/update.sh | bash

Setup API key

arrowcode --setup
# or
export NVIDIA_API_KEY=nvapi-...

~/.arrowcode is created only by --setup, --init, or ./install.sh / install.ps1 (copied from defaults/).

Doc Contents
HOW_TO_USE.md Detailed premium startup, commands, and layouts guide
GUIDE.md Full command reference + working playbooks + diagrams
docs/ARCHITECTURE.md System design
docs/SESSIONS.md Session memory
docs/SECURITY.md Policy / sandbox
docs/PERFORMANCE.md Speed kit
docs/TOOLS.md Tool catalog
FEATURES.md Feature list / roadmap

Usage

cd /path/to/your-project
arrowcode

Core loop

/session new my-feature
/templates fullstack
/plan Add a /health API and status page
# answer 1. … 2. …
/confirm
/accept

Useful commands

Area Commands
Loop /plan /confirm /accept /reject /stop /review
Sessions /session new|list|load|save|memory|delete
Safety /yolo /dryrun /allowlist /secretscan /budget /undo
System /settings /status /cost /swarm /perf /help /exit

Routing: @fe @be @qa @orch @all

Full list: GUIDE.md

Defaults vs user home

Location When What
defaults/ in git always personalities, templates, example config
~/.arrowcode/ after install/setup only your keys + overrides
<project>/.arrowcode-sessions/ while coding sessions / exports
<project>/.arrowcode-checkpoints/ while coding /undo snapshots

Runtime works without ~/.arrowcode using packaged defaults/.

Development / CI

bun install
bun run typecheck
bun run test:smoke
bun run ci
bun run src/index.ts --help

GitHub Actions: .github/workflows/ci.yml runs typecheck, CLI smoke, and integration smoke.