boxglow 0.6.0 → 0.6.2
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 +58 -13
- package/bin/boxglow.js +4724 -1051
- package/dist/assets/index-BpZb2sGB.css +1 -0
- package/dist/assets/index-DmRfg1K8.js +3604 -0
- package/dist/icon-180.png +0 -0
- package/dist/icon-192.png +0 -0
- package/dist/icon-512-maskable.png +0 -0
- package/dist/icon-512.png +0 -0
- package/dist/index.html +7 -2
- package/docs/AGENTS_SNIPPET.md +13 -7
- package/examples/notes-app/boxglow.json +126 -28
- package/package.json +18 -4
- package/dist/assets/index-DSK28cPU.js +0 -3479
- package/dist/assets/index-T2Nrf6LN.css +0 -1
package/README.md
CHANGED
|
@@ -7,10 +7,46 @@ Tasks are boxes with inputs and outputs; a box goes New (BlackBox: output decide
|
|
|
7
7
|
|
|
8
8
|
**計画と進捗を、ボックスと線で。AI エージェントとチームが今どこを作っていて、何が終わり、どこで判断を待っているかが一目でわかる。**
|
|
9
9
|
|
|
10
|
-
- Web app: https://boxglow.
|
|
10
|
+
- Web app: https://boxglow.app/ (works without sign-in: data stays in your browser, or opens a local `boxglow.json`. Sign in to sync plans across devices)
|
|
11
11
|
- CLI for agents: `npx boxglow` (status / start / done / split / ask / answer ...)
|
|
12
12
|
- License: MIT
|
|
13
13
|
|
|
14
|
+
## What's new in 0.6.2
|
|
15
|
+
|
|
16
|
+
- **`setup-agent` sets up everything for Claude Code and Codex**: hooks (the plan's resume summary is injected when a session starts, resumes or is compacted; an agent about to finish with an unrecorded box is told to record first; direct edits of `boxglow.json` are blocked), MCP registration, a review subagent, and the context guard. `setup-agent --check` shows what is installed, when each hook last fired, and the one-time steps left to you (Codex: trust the project and approve the hooks in the terminal CLI).
|
|
17
|
+
- **Verification at done**: `boxglow done --checked "<checks run and results>" [--not-checked …] [--limits …]` stays on the box and shows in `show`, `context` and the Status tab.
|
|
18
|
+
- **Sync you can stop**: "Stop syncing / Resume syncing" and "Disconnect this plan on this device"; a **Constraints** field under the outputs; a safer merge into `~/.codex/config.toml`; a usability pass (fewer steps on Home, clearer buttons and labels, a scrolling account menu).
|
|
19
|
+
|
|
20
|
+
Details: [CHANGELOG.md](CHANGELOG.md). Update the CLI, `serve` and the VS Code extension (0.5.2) together.
|
|
21
|
+
|
|
22
|
+
### 日本語: 0.6.2 の要点
|
|
23
|
+
|
|
24
|
+
- **`setup-agent` だけで Claude Code と Codex の両方が整う**: hooks (セッションの開始・再開・圧縮の後に計画の再開の概要を文脈へ、記録の無い箱を残したまま終えようとすると記録を促す、boxglow.json の直接編集を止める)、MCP の登録、レビュー用のサブエージェント、確認トークン。`setup-agent --check` で、入っているもの・各 hook の最後の発火・利用者が一度だけ行うこと (Codex はプロジェクトの信頼とターミナルの CLI での hooks の承認) を表示。
|
|
25
|
+
- **完了のときの検査結果**: `boxglow done --checked "<実行した検査と結果>" [--not-checked …] [--limits …]` が箱に残り、show・context・Status タブに出る。
|
|
26
|
+
- **止められる同期** (「同期を止める / 再開する」「この端末の結び付けを解除する」)、出力の下の**制約**の欄、`~/.codex/config.toml` への安全な併合、使いやすさの見直し (Home の手数、ボタンの見た目、アカウントメニューのスクロール)。
|
|
27
|
+
|
|
28
|
+
## What's new in 0.6.1
|
|
29
|
+
|
|
30
|
+
- **Sync in the browser alone** at [boxglow.app](https://boxglow.app): sign in with GitHub or Google, put a plan on the server or receive one, and it syncs while the tab is open. `serve` and the VS Code extension sync the same way with a local file.
|
|
31
|
+
- **Account menu** (top right): plan and subscription management, sign-in methods, sign out, delete account. **History** (go back to a previous server version) and **share links** (read-only, no sign-in needed) live in the sync panel.
|
|
32
|
+
- **Paid plans**: Personal 500 JPY / month (Stripe). Billing is not enforced during the invited beta. Plan contents are encrypted at rest with a per-account key.
|
|
33
|
+
- **Notes with live Markdown preview**, a per-box work log, pasted images, the Now marker, a resizable block tree.
|
|
34
|
+
- **Workspaces (teams)**: invite people with a link and sync the same plan; Team subscription per workspace. **Hosted MCP**: Claude Code / Codex use a plan on the server with no local file ("Connect Claude Code / Connect Codex" writes the config).
|
|
35
|
+
- **Install as an app (PWA)**, your own **plan templates**, **combine / split** plan files, **edit a file opened directly in the browser**, sign-in stored on **Windows** itself.
|
|
36
|
+
- **Sync you can stop** ("Stop syncing / Resume syncing", "Disconnect this plan on this device"), a **Constraints** field under the outputs, and a usability pass (fewer steps, clearer buttons and labels).
|
|
37
|
+
|
|
38
|
+
Details: [CHANGELOG.md](CHANGELOG.md). Update the CLI, `serve` and the VS Code extension (0.5.1) together.
|
|
39
|
+
|
|
40
|
+
### 日本語: 0.6.1 の要点
|
|
41
|
+
|
|
42
|
+
- **ブラウザだけで同期**: [boxglow.app](https://boxglow.app) で GitHub か Google でサインインし、計画をサーバーに置く・受け取る。タブを開いている間は自動で同期します。`serve` と VS Code 拡張は手元のファイルで同じように同期します。
|
|
43
|
+
- **右上のアカウントのメニュー**: プランと契約の管理、サインインの手段、サインアウト、アカウントの削除。**履歴** (サーバーの前の版に戻す) と **共有リンク** (閲覧専用、サインイン不要) は同期パネルから。
|
|
44
|
+
- **有料プラン**: Personal 月 500 円 (Stripe)。招待制の試用の間は請求しません。計画の中身はアカウントごとの鍵で暗号化して保存します。
|
|
45
|
+
- **メモのライブプレビュー (Markdown)**、ボックスごとの作業記録、画像の貼り付け、NOW の印、幅を変えられるツリー。
|
|
46
|
+
- **ワークスペース (チーム)**: 招待リンクで人を招き、同じ計画を同期。契約はワークスペースごと (人数分)。**ホスト型 MCP**: Claude Code / Codex が手元にファイルの無い計画をサーバー経由で読み書き (「Claude Code に接続 / Codex に接続」が設定を書く)。
|
|
47
|
+
- **アプリとしてインストール (PWA)**、自分の**テンプレート**、計画ファイルの**結合 / 分割**、**ブラウザで直接開いたファイルの編集**、**Windows** でのサインインの保存。
|
|
48
|
+
- **止められる同期** (「同期を止める / 再開する」「この端末の結び付けを解除する」)、出力の下の**制約**の欄、使いやすさの見直し (手数・ボタンの見た目・ラベル)。
|
|
49
|
+
|
|
14
50
|
## What's new in 0.6.0
|
|
15
51
|
|
|
16
52
|
- **A diagram you can read at a glance**: boxes are cards (category, title, state, then inputs on the left and outputs on the right) with a header colored by state. In View mode boxes are laid out in dependency order as numbered stages; a vertical, top-to-bottom view is one click away. Your own layout in the file is untouched and is used in Edit mode.
|
|
@@ -51,7 +87,7 @@ npx boxglow done "Build it" --artifact "app=src/App.tsx" # de
|
|
|
51
87
|
|
|
52
88
|
Recommended flow for a new project: the agent reads the brief (README, request) and creates 3-7 top-level boxes with concrete outputs, asks the human to confirm the split (`ask`), and only then decomposes the box it starts (`split`). Decisions keep the candidates that were not chosen; `reopen` lets you change course later without losing the history.
|
|
53
89
|
|
|
54
|
-
Then run `npx boxglow setup-agent` once. It installs
|
|
90
|
+
Then run `npx boxglow setup-agent` once. It installs everything the agents need so you do not have to know the mechanisms: the instructions (`CLAUDE.md` / `AGENTS.md`), the skill, the hooks (the plan's resume summary is injected when a session starts, resumes or is compacted; an agent that is about to finish with an unrecorded box is told to record first; direct edits of `boxglow.json` are blocked), the MCP server registration (`.mcp.json` for Claude Code, approved for boxglow only via `enabledMcpjsonServers`; `.codex/config.toml` for Codex), a review subagent, and the context guard described below. `npx boxglow setup-agent --check` lists what is installed and the one-time steps left to you (Codex: trust the project and approve the hooks in `/hooks` once). Open `npx boxglow serve --open` or the [VS Code extension](https://marketplace.visualstudio.com/items?itemName=sukima.boxglow-vscode) to edit the same repository file as the agent.
|
|
55
91
|
|
|
56
92
|
### Remember decisions across sessions
|
|
57
93
|
|
|
@@ -76,7 +112,8 @@ MCP provides `boxglow_context`, `boxglow_checkpoint`, and `contextToken` on guar
|
|
|
76
112
|
|
|
77
113
|
| Command | What it does |
|
|
78
114
|
|---|---|
|
|
79
|
-
| `setup-agent [--agent codex\|claude-code\|all]` | Install
|
|
115
|
+
| `setup-agent [--agent codex\|claude-code\|all] [--check]` | Install the selected agent's instructions, skill, hooks, MCP registration and review subagent (default: `all`). `--check` lists what is installed / missing. Existing unrelated settings are preserved; malformed settings stop setup. |
|
|
116
|
+
| `hook session-start\|stop\|pre-tool` | Called by the agents' hooks (registered by setup-agent; JSON on stdin). Never stops the agent on its own failure. |
|
|
80
117
|
| `mcp [--file path]` | MCP server over stdio: every command above as a tool (`boxglow_status`, `boxglow_add`, `boxglow_split`, `boxglow_start`, `boxglow_done`, `boxglow_ask`, `boxglow_answer`, ... and `boxglow_run` for the rest) |
|
|
81
118
|
| `serve [--port 4174] [--open]` | Local server: the bundled web app at `http://localhost:4174/?serve=1` reading and writing your `boxglow.json` through a small API, with live reload when the CLI or an agent changes the file. Works in any browser (Firefox, Safari) |
|
|
82
119
|
| `context <block> [--brief]` / `checkpoint <block> --note ... --context-token ...` | Read persistent context with a receipt (`--brief`: short form to read first, same token) / record a durable handoff |
|
|
@@ -109,17 +146,15 @@ npx boxglow setup-agent --agent codex
|
|
|
109
146
|
npx boxglow status --brief
|
|
110
147
|
```
|
|
111
148
|
|
|
112
|
-
This installs `AGENTS.md
|
|
149
|
+
This installs `AGENTS.md`, `.agents/skills/boxglow/SKILL.md` (with `agents/openai.yaml` declaring the MCP dependency), `.codex/config.toml` (the local MCP server `boxglow`, tools auto-approved), `.codex/hooks.json` (session-start / stop / pre-tool) and `.codex/agents/boxglow-review.toml`; it does not create Claude Code settings. `--agent claude-code` installs only Claude Code files; omit `--agent` to install both. To use the tools before the project is trusted, you can also register the server in your Codex user config yourself: `codex mcp add boxglow -- npx -y boxglow mcp --actor codex` (setup-agent does not change your user config).
|
|
113
150
|
|
|
114
|
-
|
|
151
|
+
Two things Codex asks you to do once: trust the project when you first open it (project-level MCP and hooks only run in trusted projects), and approve the Boxglow hooks in `/hooks`. `npx boxglow setup-agent --check` shows these and what is installed. `.mcp.json` in a repository is the Claude Code setup; it is not the Codex MCP registration. MCP `boxglow_status` accepts `brief: true`.
|
|
115
152
|
|
|
116
|
-
|
|
117
|
-
codex mcp add boxglow -- npx -y boxglow mcp --file /absolute/path/to/boxglow.json --actor codex
|
|
118
|
-
```
|
|
153
|
+
See the official [Codex skills locations](https://learn.chatgpt.com/docs/build-skills) and [Codex MCP configuration](https://learn.chatgpt.com/docs/extend/mcp?surface=cli).
|
|
119
154
|
|
|
120
|
-
|
|
155
|
+
## On a phone or tablet
|
|
121
156
|
|
|
122
|
-
|
|
157
|
+
Open https://boxglow.app and use "Add to Home Screen" (Share menu on iPhone, browser menu on Android): Boxglow opens like an app, and the last loaded screen with the plans saved in that browser works offline (sync resumes when online). The vertical flow is the default below 900 px; decisions can be answered from the Activity list or the box panel.
|
|
123
158
|
|
|
124
159
|
## Any browser: `npx boxglow serve`
|
|
125
160
|
|
|
@@ -154,9 +189,19 @@ Before removing, stop every Boxglow that has the plan open (CLI, `serve`, VS Cod
|
|
|
154
189
|
|
|
155
190
|
The server finds `boxglow.json` like the CLI does (current directory upwards, or `--file` / `BOXGLOW_FILE`). The CLI and the MCP tools write the same file, so either can be used.
|
|
156
191
|
|
|
192
|
+
### Teams (workspaces)
|
|
193
|
+
|
|
194
|
+
Account menu → **Workspace** → create one (just a name), then **Create an invite link** (viewer or editor) and send the `https://boxglow.app/#join=...` URL; the other person signs in, opens it and joins. When starting sync, choose the workspace under "Put it in" (or "Receive from" on Home) and the plan lives in the team: everyone with the editor role syncs it, viewers can read it, admins manage members, invites, share links, agent tokens and the subscription (Team plan, per workspace, seats = member limit). CLI: `boxglow team ...`, `boxglow sync --team <ID>`, `boxglow remote ... --team <ID>`. Details: [docs/SYNC_START.md](docs/SYNC_START.md) (Japanese).
|
|
195
|
+
|
|
196
|
+
### Hosted MCP (no local file)
|
|
197
|
+
|
|
198
|
+
A plan placed on the sync server can also be reached over HTTP MCP at `https://sync.boxglow.app/mcp`, so an agent on another machine (or a cloud agent) works on it without a local `boxglow.json`. Account menu → "AI agent access" → **Connect Claude Code** (or Codex): in serve and VS Code this creates the token and writes the config file (`.mcp.json` next to the plan, or `~/.codex/config.toml`); in the browser app it gives you the config file to download and the three steps to place it. CLI: `boxglow agent-token connect claude-code|codex`. Tokens are per plan, read-only or read-write, up to 10 per account, and can be revoked from the same place.
|
|
199
|
+
|
|
200
|
+
Writes become new versions on the server and reach the synced devices on their next sync. Details: [docs/HOSTED_MCP.md](docs/HOSTED_MCP.md) (Japanese).
|
|
201
|
+
|
|
157
202
|
## VS Code extension
|
|
158
203
|
|
|
159
|
-
Install **Boxglow** from the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=sukima.boxglow-vscode): search for "Boxglow" in the Extensions view, or run `code --install-extension sukima.boxglow-vscode`. Keep the extension and the CLI on matching releases (extension 0.5.
|
|
204
|
+
Install **Boxglow** from the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=sukima.boxglow-vscode): search for "Boxglow" in the Extensions view, or run `code --install-extension sukima.boxglow-vscode`. Keep the extension and the CLI on matching releases (extension 0.5.2 goes with boxglow 0.6.2).
|
|
160
205
|
|
|
161
206
|
`vscode/` holds the extension's source. It opens `boxglow.json` as the same diagram inside the editor (custom editor "Boxglow"; right-click the file or use the editor title button / command *Boxglow: Open boxglow.json as a diagram*). The diagram follows the file when the CLI or an agent writes it, edits in the diagram are written back, and light / dark follow the VS Code theme. To build it yourself: `npm run build:vscode` (bundles the web app into `vscode/media/`), then `cd vscode && npm run package` (`.vsix`, install via *Extensions: Install from VSIX...*).
|
|
162
207
|
|
|
@@ -212,7 +257,7 @@ Expanded boxes (containers) are drawn as frames: the shallower the level, the th
|
|
|
212
257
|
- Input groups: project inputs can be grouped (e.g. "PCIe specs", "DDR specs"); each group is its own input node, and a group can be exported / imported as `*.boxglow-inputs.json` to reuse in another project (`boxglow group`, `group-set`, `group-export`, `group-import`).
|
|
213
258
|
- Boxes never overlap: when a box is added, moved or grows, only the siblings it now overlaps are pushed right or down; the grown box stays put and the rest of the plan keeps its positions.
|
|
214
259
|
- Readiness: "the inputs are in" and "the work is concrete enough to start" are judged separately. An output carries a planned deliverable (`expect`, e.g. `file:src/auth/callback.ts`; `note` for an investigation) next to the real deliverables, and the acceptance criteria live in the scope. `boxglow context` prints the `readiness` (ready / needs detail / waiting, with reasons and the next commands), candidates are grouped the same way, and the canvas, side panel and In charge table show "needs detail". `start` warns on such a box (`policy --unprepared reject` refuses AI starts; a reason does not bypass it), and `boxglow claim <block>` holds a box for planning without starting it. `split` takes `expect` / `acceptance` per child (only for the ones you start now) and `parentMakes` for outputs the parent makes itself.
|
|
215
|
-
- Branches: a branch box (+ Block → Branch, or `boxglow branch "<title>" --options "A|B"`) shows a fork that is not decided yet (an existing box can be turned into one from its
|
|
260
|
+
- Branches: a branch box (+ Block → Branch, or `boxglow branch "<title>" --options "A|B"`) shows a fork that is not decided yet (an existing box can be turned into one from the Actions row on its More tab, or `boxglow branch --box <block>`). Each option is a path (output). Boxes on the paths wait for the answer; once you pick a path (Choose a path at the top of the side panel, or `boxglow answer`), the paths not chosen are skipped (faded, left out of progress, next candidates and lists). A branch is drawn as a card with cut corners and an "IF" diamond on its edge. Where paths come together, a merge part drawn like an OR gate (+ Block → Merge, or `boxglow join`) passes the work on as soon as any one path arrives.
|
|
216
261
|
- Edit / View: a top-bar toggle; in View mode drag-and-drop editing and the Delete key are off. View lays boxes out in dependency order as numbered stages (left to right, or top to bottom with the vertical view in the zoom panel); Edit shows and edits the layout saved in the file. You cannot zoom out further than the whole diagram (Fit), and selecting a box or opening a panel keeps your zoom and position.
|
|
217
262
|
- Short IDs: every box gets `B1`, `B2`, ... shown on the box; search by ID or title from the top bar (`/`), and use the ID in the CLI.
|
|
218
263
|
- Schedule: start date, due date, estimate and actual hours per box; overdue boxes are flagged.
|
|
@@ -235,7 +280,7 @@ An English example lives in `examples/notes-app/boxglow.json` (a small notes app
|
|
|
235
280
|
|
|
236
281
|
## Free and paid
|
|
237
282
|
|
|
238
|
-
Boxglow is open core: everything that works with the one file on your machine (web app, CLI, Git workflow, members, parts, categories, dates, the VS Code extension) is MIT and stays free. Cloud sync, share links, team workspaces, Slack / JIRA connectors, a hosted MCP endpoint and a self-hosted edition are the paid product in preparation. The exact line is written down in [docs/MONETIZATION.md](docs/MONETIZATION.md); features already released under MIT will not move behind a paywall, and the paid product never stores your source or documents. To hear when it opens: https://boxglow.pages.dev/waitlist/
|
|
283
|
+
Boxglow is open core: everything that works with the one file on your machine (web app, CLI, Git workflow, members, parts, categories, dates, the VS Code extension) is MIT and stays free. Cloud sync, share links, team workspaces, Slack / JIRA connectors, a hosted MCP endpoint and a self-hosted edition are the paid product in preparation. The Personal plan (cloud sync, history, share links) is 500 JPY per month, tax included, with no free tier and no trial; the Team plan (800 JPY per person per month) follows with the team features. During the invited beta nothing is charged. The exact line is written down in [docs/MONETIZATION.md](docs/MONETIZATION.md); features already released under MIT will not move behind a paywall, and the paid product never stores your source or documents. To hear when it opens: https://boxglow.pages.dev/waitlist/
|
|
239
284
|
|
|
240
285
|
## Development
|
|
241
286
|
|