boxglow 0.6.0 → 0.6.1
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 +40 -4
- package/bin/boxglow.js +4244 -957
- package/dist/assets/index-BpZb2sGB.css +1 -0
- package/dist/assets/index-ujaBGwdT.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 +7 -5
- 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,32 @@ 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.1
|
|
15
|
+
|
|
16
|
+
- **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.
|
|
17
|
+
- **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.
|
|
18
|
+
- **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.
|
|
19
|
+
- **Notes with live Markdown preview**, a per-box work log, pasted images, the Now marker, a resizable block tree.
|
|
20
|
+
- **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).
|
|
21
|
+
- **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.
|
|
22
|
+
- **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).
|
|
23
|
+
|
|
24
|
+
Details: [CHANGELOG.md](CHANGELOG.md). Update the CLI, `serve` and the VS Code extension (0.5.1) together.
|
|
25
|
+
|
|
26
|
+
### 日本語: 0.6.1 の要点
|
|
27
|
+
|
|
28
|
+
- **ブラウザだけで同期**: [boxglow.app](https://boxglow.app) で GitHub か Google でサインインし、計画をサーバーに置く・受け取る。タブを開いている間は自動で同期します。`serve` と VS Code 拡張は手元のファイルで同じように同期します。
|
|
29
|
+
- **右上のアカウントのメニュー**: プランと契約の管理、サインインの手段、サインアウト、アカウントの削除。**履歴** (サーバーの前の版に戻す) と **共有リンク** (閲覧専用、サインイン不要) は同期パネルから。
|
|
30
|
+
- **有料プラン**: Personal 月 500 円 (Stripe)。招待制の試用の間は請求しません。計画の中身はアカウントごとの鍵で暗号化して保存します。
|
|
31
|
+
- **メモのライブプレビュー (Markdown)**、ボックスごとの作業記録、画像の貼り付け、NOW の印、幅を変えられるツリー。
|
|
32
|
+
- **ワークスペース (チーム)**: 招待リンクで人を招き、同じ計画を同期。契約はワークスペースごと (人数分)。**ホスト型 MCP**: Claude Code / Codex が手元にファイルの無い計画をサーバー経由で読み書き (「Claude Code に接続 / Codex に接続」が設定を書く)。
|
|
33
|
+
- **アプリとしてインストール (PWA)**、自分の**テンプレート**、計画ファイルの**結合 / 分割**、**ブラウザで直接開いたファイルの編集**、**Windows** でのサインインの保存。
|
|
34
|
+
- **止められる同期** (「同期を止める / 再開する」「この端末の結び付けを解除する」)、出力の下の**制約**の欄、使いやすさの見直し (手数・ボタンの見た目・ラベル)。
|
|
35
|
+
|
|
14
36
|
## What's new in 0.6.0
|
|
15
37
|
|
|
16
38
|
- **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.
|
|
@@ -121,6 +143,10 @@ Use `codex mcp list` to verify the registration. `.mcp.json` in a repository is
|
|
|
121
143
|
|
|
122
144
|
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).
|
|
123
145
|
|
|
146
|
+
## On a phone or tablet
|
|
147
|
+
|
|
148
|
+
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.
|
|
149
|
+
|
|
124
150
|
## Any browser: `npx boxglow serve`
|
|
125
151
|
|
|
126
152
|
The web app opens a local `boxglow.json` directly only in Chrome / Edge (File System Access API), and those browsers refuse some locations: a file inside WSL (`\\wsl.localhost\...`) is rejected with a "contains system files" message. Use `serve` (or the VS Code extension) for those. `npx boxglow serve` runs a small local server (127.0.0.1 only) that serves the bundled app and exposes the file as `GET/PUT /api/project` plus an SSE `/api/events` stream, so the page updates a moment after the CLI or an agent writes the file, and edits in the page are written back. Open `http://localhost:4174/?serve=1` (`--open` opens it for you).
|
|
@@ -154,9 +180,19 @@ Before removing, stop every Boxglow that has the plan open (CLI, `serve`, VS Cod
|
|
|
154
180
|
|
|
155
181
|
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
182
|
|
|
183
|
+
### Teams (workspaces)
|
|
184
|
+
|
|
185
|
+
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).
|
|
186
|
+
|
|
187
|
+
### Hosted MCP (no local file)
|
|
188
|
+
|
|
189
|
+
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.
|
|
190
|
+
|
|
191
|
+
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).
|
|
192
|
+
|
|
157
193
|
## VS Code extension
|
|
158
194
|
|
|
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.
|
|
195
|
+
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.1 goes with boxglow 0.6.1).
|
|
160
196
|
|
|
161
197
|
`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
198
|
|
|
@@ -212,7 +248,7 @@ Expanded boxes (containers) are drawn as frames: the shallower the level, the th
|
|
|
212
248
|
- 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
249
|
- 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
250
|
- 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
|
|
251
|
+
- 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
252
|
- 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
253
|
- 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
254
|
- Schedule: start date, due date, estimate and actual hours per box; overdue boxes are flagged.
|
|
@@ -235,7 +271,7 @@ An English example lives in `examples/notes-app/boxglow.json` (a small notes app
|
|
|
235
271
|
|
|
236
272
|
## Free and paid
|
|
237
273
|
|
|
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/
|
|
274
|
+
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
275
|
|
|
240
276
|
## Development
|
|
241
277
|
|