@starlove/orbit 1.0.2 → 1.0.4
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.
- package/README.md +6 -5
- package/dist/full/index.html +1 -1
- package/dist/full/js/{app.70be7d06.js → app.7e25f59b.js} +57 -57
- package/dist/full/js/app.7e25f59b.js.map +7 -0
- package/dist/full/version.json +2 -2
- package/docs/MCP_SETUP.md +1 -1
- package/package.json +1 -1
- package/public/js/create-card.js +2 -2
- package/public/js/kanban.js +2 -2
- package/public/js/settings.js +8 -7
- package/public/js/state.js +16 -0
- package/public/js/ticket-detail.js +2 -2
- package/src/cli/orbit.js +30 -58
- package/src/core/agents-md.js +88 -0
- package/src/core/boards.js +71 -14
- package/src/core/delete-board.js +49 -5
- package/src/core/provision-repo-board.js +8 -2
- package/src/core/seed.js +14 -6
- package/dist/full/js/app.70be7d06.js.map +0 -7
package/README.md
CHANGED
|
@@ -37,6 +37,7 @@ From the repo you want a board for:
|
|
|
37
37
|
cd path/to/your-app
|
|
38
38
|
orbit init # creates .orbit/board.db + SKILL-ORBIT.md + AGENTS.md
|
|
39
39
|
orbit init --example # optional: add onboarding example tickets
|
|
40
|
+
orbit init --no-ai # optional: create or update the board with AI disabled
|
|
40
41
|
```
|
|
41
42
|
|
|
42
43
|
Start one runtime and keep using it:
|
|
@@ -67,9 +68,9 @@ Wipe a single board and start over with `orbit reset` (deletes `.orbit/`, `SKILL
|
|
|
67
68
|
|
|
68
69
|
## Use with AI
|
|
69
70
|
|
|
70
|
-
Orbit ships with everything an agent needs to claim work, read tickets, and write back implementation notes
|
|
71
|
+
Orbit ships with everything an agent needs to claim work, read tickets, and write back implementation notes. New boards have AI collaboration enabled by default; pass `orbit init --no-ai` or turn off **Enable AI** in Settings → AI if you want a human-only board.
|
|
71
72
|
|
|
72
|
-
1. **
|
|
73
|
+
1. **Confirm AI is enabled.** Open Settings (gear icon) → **AI** tab → toggle **Enable AI** if needed. Orbit provisions the `AI Ready`, `In Progress`, and `Review` lanes if they're missing, surfaces the agent-context fields, and reveals the MCP setup snippet.
|
|
73
74
|
2. **Fill in agent context.** Settings → AI → *Agent Instructions* is the project-level briefing every agent reads before touching a ticket. Describe what the project is, who it serves, the stack, and any rules of the road.
|
|
74
75
|
3. **Register the MCP server with your agent.** The AI tab generates copy-pasteable snippets for Claude Code, Cursor, Codex, OpenCode, OpenClaw, and other MCP-capable clients — pick your OS + client and paste the command into your agent's MCP config.
|
|
75
76
|
4. **Restart the agent.** On its next boot it discovers the Orbit MCP tools (`board_claim_next`, `board_get_ticket_context`, `board_update_ticket`, etc.).
|
|
@@ -80,7 +81,7 @@ If you initialized with `--example`, ticket #12 (`Try Orbit MCP on this ticket`)
|
|
|
80
81
|
## Vocabulary
|
|
81
82
|
|
|
82
83
|
- **Board** — one repo's planning surface. Each board carries its own `agent_instructions`, lanes, tickets, and memory entries.
|
|
83
|
-
- **Lane** — a column. Lanes are user-defined and freely named/reordered. The seed gives you `Backlog`, `Todo`, `In Progress`, `Review`, `Done`, `Cancelled`;
|
|
84
|
+
- **Lane** — a column. Lanes are user-defined and freely named/reordered. The default seed gives you `Backlog`, `Todo`, `AI Ready`, `In Progress`, `Review`, `Done`, `Cancelled`; `AI Ready`, `In Progress`, and `Review` are anchor lanes the agent flow keys off. `AI Ready` is inserted between `Todo` and `In Progress` when AI is enabled.
|
|
84
85
|
- **Ticket types**:
|
|
85
86
|
- `epic` — index card for a multi-feature initiative. Owns child tickets via `parent_ticket_id`.
|
|
86
87
|
- `feature` — a standalone capability or new behavior.
|
|
@@ -101,7 +102,7 @@ Bun is not used as the Orbit runtime because Orbit depends on Node's built-in `n
|
|
|
101
102
|
|
|
102
103
|
Each repo gets its own board database. Orbit keeps a small central registry that maps repo paths to their board files; the CLI, web app, and MCP server use explicit project roots when provided, then fall back to walking upward to find `.orbit/board.db`.
|
|
103
104
|
|
|
104
|
-
- **Per-repo board** — `.orbit/board.db` lives in the repo it tracks. `orbit init` creates it, drops `SKILL-ORBIT.md` at the repo root, and creates/updates `AGENTS.md` with a terse pointer so agents load the full Orbit protocol only when relevant. Add `--example` to create onboarding cards.
|
|
105
|
+
- **Per-repo board** — `.orbit/board.db` lives in the repo it tracks. `orbit init` creates it, drops `SKILL-ORBIT.md` at the repo root, and creates/updates `AGENTS.md` with a terse pointer so agents load the full Orbit protocol only when relevant. Add `--example` to create onboarding cards, or `--no-ai` to disable AI collaboration for the board.
|
|
105
106
|
- **Central registry** — `registry.db` records each board's path, slug, and last-active timestamp. Host `orbit serve` uses `~/.orbit`; `orbit docker` uses `<repo>/.orbit/docker-data`. Keep one mode unless you intentionally share `DATA_DIR`, re-register boards, or import snapshots.
|
|
106
107
|
- **Project-root discovery** — `orbit serve`, `orbit mcp`, and MCP-attached agents resolve a board from an explicit `--cwd` / `PROJECT_ROOT` first, then fall back to walking up from process cwd to find `.orbit/board.db`. Persistent MCP configs should use an explicit root so the right board attaches even when the agent launches elsewhere.
|
|
107
108
|
- **Two channels for AI** — `AGENTS.md` is the auto-loaded briefing, with an Orbit-managed pointer to `SKILL-ORBIT.md`; the *MCP config* tells the agent runtime how to launch Orbit's MCP server for the right project. The briefing travels with the repo; the MCP registration is per-agent-install.
|
|
@@ -167,7 +168,7 @@ A copy-editable client config lives at [docs/mcp-client.example.json](docs/mcp-c
|
|
|
167
168
|
- **Board**: name from `BOARD_NAME` env var, otherwise inferred from `package.json` `name` or the repo folder name. Slug from `BOARD_SLUG` or derived from the name.
|
|
168
169
|
- **Repo metadata**: `REPO_URL` env var or `git config --get remote.origin.url`; `SYSTEM_PATH` env var or the repo path passed to `orbit init`.
|
|
169
170
|
- **Default branch**: `DEFAULT_BRANCH` env var, otherwise the current git branch.
|
|
170
|
-
- **Lanes (
|
|
171
|
+
- **Lanes (7)**: `Backlog`, `Todo` (default), `AI Ready`, `In Progress`, `Review`, `Done`, `Cancelled`. Pass `--no-ai` to seed without `AI Ready` and leave AI collaboration disabled.
|
|
171
172
|
- **Labels (7)**: `human-only`, `needs-human-input`, `needs-decomposition`, `needs-followup`, `tech-debt`, `security`, `onboarding`.
|
|
172
173
|
- **Onboarding cards (optional)**: pass `--example` to create an epic `#1` plus children `#2`, `#3`, and `#12 — Try Orbit MCP on this ticket`.
|
|
173
174
|
- **Free-form fields**: `project_notes` (Notes tab) and `agent_instructions` (AI tab) get placeholder text you should replace.
|