AI-driven milestone tracker for Claude Code sessions
Project description
Beacon
Milestone-driven project dashboard for AI-assisted development
AIアシスタント(Claude Code等)との開発セッションにおいて、マイルストーンベースのプロジェクト進捗を常時可視化し、方向性を見失わずに実装を進めるためのツール。
A real-time project dashboard that keeps milestone-based progress visible during AI-assisted development sessions (e.g., Claude Code), so you never lose sight of the bigger picture.
Why Beacon?
Beacon is not a task management tool. If you need to plan tasks upfront and check them off, use Notion or Linear.
Beacon is built for a different workflow: commit-driven, milestone-oriented development. You set a milestone (the destination), then each developer — human or AI — autonomously decides what to do next, commits, and records progress. Tasks emerge from the work, not the other way around.
This matters especially in AI-assisted development, where sessions are short-lived and context is easily lost. Beacon keeps the bigger picture visible so that each session can pick up where the last one left off.
Beaconはタスク管理ツールではありません。 タスクを事前に起票して消化していくなら、NotionやLinearを使ってください。
Beaconが想定するワークフローはコミット駆動・マイルストーン指向の開発です。まずマイルストーン(目的地)を設定し、開発者 — 人間でもAIでも — が自律的に次にやるべきことを判断し、コミットし、進捗を記録します。タスクは作業から生まれるものであり、事前に計画するものではありません。
これはAI駆動開発において特に重要です。セッションは短命でコンテキストは失われやすい。Beaconは全体像を常に可視化し、次のセッションが前回の続きからスムーズに再開できるようにします。
Key Features
- Always-visible dashboard — Tauri Desktop App or Web UI shows live progress alongside your working shell
- Audit trail — every commit and task is recorded under a milestone, making AI session handoffs transparent and human-auditable
- CLI-first design — structured JSON output enables seamless integration with Claude Code Skills
- Trek (cross-project協奏作業領域) —
beacon trekで複数プロジェクト・複数セッションをまたぐ協奏作業を 1 枚の trek にまとめて追跡できる。CLI でも Web UI でも同じ trek を見て協奏でき、参加・離脱・対象 (scope) 編集・非常停止 (halt) も CLI 1 行で。詳細は CLI Commands → Treks
Requirements
- Python 3.9+ (CLI core)
- Git (for commit tracking and worktree dispatch)
Installation
Beacon ships in two forms that work independently:
- Beacon Desktop — Tauri-based UI app (
.dmg/.msi/.AppImage) you double-click. CLI is bundled inside. - Beacon CLI — command-line tool (
beacon) for terminal users, AI agents, and CI.
Quick install — pick your OS
| OS | Beacon Desktop | Beacon CLI |
|---|---|---|
| macOS | brew install --cask beacon-desktopor download .dmg from Releases |
brew install r-kida2/beacon/beaconor pipx install beacon-ai |
| Windows | winget install BeaconAI.BeaconDesktopor download .msi from Releases |
pipx install beacon-ai |
| Linux | Download .AppImage from Releases and chmod +x |
pipx install beacon-aior Homebrew on Linux |
pipx install beacon-ai works natively on all three OSes — PowerShell-only Windows users get the full CLI without WSL2.
For cloud features (Google auth, team collaboration), add the cloud extra:
pipx install 'beacon-ai[cloud]'
See INSTALL.md for full details: tap setup for maintainers, code-signing status, SmartScreen workarounds, troubleshooting per OS.
Quick Start
Run the setup wizard from your project directory:
cd your-project
beacon setup
beacon setup handles everything in one go:
- Sign in with Google (for cloud features)
- Install Claude Code Skills and hooks
- Initialize a new local project — or join an existing cloud project
- Launch the UI (Tauri Desktop App or Web UI)
Path A: New local project
Choose option 1 in step 3. The wizard prompts for a project name and objective, then shows your status and UI pointers.
beacon setup
# → Step 3: Choose [1] New local project
# → Step 4: Show status + UI pointers? [Y]
beacon milestone add "First milestone"
beacon milestone start ms-1
For live progress visualization, use the Tauri Desktop App or Web UI (after beacon cloud push).
The bare beacon command prints beacon status plus pointers to both front-ends.
To push to cloud later for Web UI access and team collaboration:
beacon cloud push
Path B: Join an existing cloud project (invited)
Choose option 2 in step 3 and enter the project ID shared by your team.
beacon setup
# → Step 3: Choose [2] Join a cloud project
# → Cloud project ID: your-project-abc123
Or skip the wizard and join directly:
beacon auth login
beacon cloud join your-project-abc123
beacon
Windows: Use
beacon auth loginfirst (opens a browser). The rest of the commands work the same in PowerShell or CMD.
Desktop App (optional)
The Desktop App provides a native window for monitoring your project alongside your terminal.
Multi-session DM (preview)
Beacon includes a real-time DM channel that lets parallel Claude Code sessions talk to each other — across machines, across worktrees, across projects. Open the same project on your Mac and your Windows box, and the two sessions can directly hand off context without you copy-pasting.
beacon setup enables this automatically; bclaude is the recommended
launcher (it's the regular claude command with the DM channel wired
up). Don't want it? beacon channel opt-out keeps it off — globally
or per-project.
bclaude # launch Claude Code with DM enabled
beacon bus directory --live # see other live sessions in the project
beacon channel status # check install / opt-out state
beacon channel opt-out --global # disable everywhere, forever
See docs/getting-started-dm.md for the
full walkthrough.
Forking a parallel session
When you want a second bclaude in a separate worktree — e.g. to give a
"difficult" milestone its own interactive session while you keep working
on the current one — use the /beacon-session-fork Skill, or call its
CLI helper directly:
beacon session fork ms-12 # creates .worktrees/ms-12-fork-<id>
# + .beacon/cloud.json + channel install
# + .beacon/fork.json (parent ↔ child link)
# then in a new terminal:
cd .worktrees/ms-12-fork-<id> && bclaude
The Skill (/beacon-session-fork ms-12) also auto-opens a new
Terminal.app / iTerm2 window on macOS and starts bclaude for you.
Cloud Mode
Beacon can sync to the cloud for Web UI access at https://beacon-ai.dev and team collaboration. All CLI commands (beacon log, beacon task, etc.) automatically work through the cloud API.
Team collaboration
The project owner can invite members from the Web UI (hamburger menu → Members). Members need to sign in at beacon-ai.dev first, then join via CLI.
| Role | Read | Write | Manage members |
|---|---|---|---|
| owner | ✓ | ✓ | ✓ |
| editor | ✓ | ✓ | — |
| viewer | ✓ | — | — |
Cloud commands
| Command | Description |
|---|---|
beacon auth login |
Sign in with Google / Googleログイン |
beacon auth status |
Show login status / ログイン状態 |
beacon cloud |
Open cloud project (interactive select; daily op) / 日常運用 |
beacon cloud status |
Show cloud config / クラウド設定表示 (read-only) |
beacon cloud list |
List cloud projects / クラウドプロジェクト一覧 |
beacon cloud join <id> |
Join an existing cloud project / 既存プロジェクトに参加 |
beacon cloud upload-initial |
Initial bootstrap upload to new cloud project / 初回 upload (special; e-1862) |
beacon cloud force-pull |
Emergency overwrite local from cloud / 緊急 force pull (special; e-1862) |
beacon cloud push |
Legacy alias of upload-initial (deprecated) / 旧名 |
beacon cloud pull |
Legacy alias of force-pull (deprecated) / 旧名 |
beacon cloud off |
Switch back to local mode (sandbox / offline only) / sandbox 用途のみ |
CLI Commands
Project
| Command | Description |
|---|---|
beacon |
Show status + pointers to Tauri Desktop App / Web UI / ステータス+UIリンク表示 |
beacon setup |
First-time setup wizard (auth + hooks + project) / 初回セットアップ |
beacon init [--name n] [--objective o] [--storage local|cloud] |
Initialize .beacon/ (flags for non-interactive use) / プロジェクト作成 |
beacon status [--json] |
Show project status / ステータス表示 |
beacon skill install |
Install Claude Code Skills / Skillインストール |
beacon monitor context [--dry-run] |
Run the Stop hook context-usage threshold monitor (debug / 動作確認) |
beacon doctor |
Check PATH, hooks, Skills, auth, and cloud config / 環境ヘルスチェック |
beacon reset |
Move .beacon/ to a timestamped backup (local only) / ローカルデータのリセット |
Milestones
| Command | Description |
|---|---|
beacon milestone add "title" [-d date] |
Add milestone / 追加 |
beacon milestone list |
List milestones / 一覧 |
beacon milestone start <id> |
Activate + auto-create ms-XX-<slug> branch + self-add as assignee (use --no-branch / --no-assignee to opt out) / アクティブ化+ブランチ自動作成+自己 assignee 登録 |
beacon milestone join <id> [--checkout] |
Add self as assignee (and optionally switch branch) / 他の MS に参加 |
beacon milestone done <id> |
Mark as done / 完了 |
beacon milestone close <id> |
Close milestone / クローズ |
beacon milestone observe <id> |
Set to observing / 監視中に設定 |
beacon milestone wait <id> --reason "..." |
Pause an active/observing milestone (ms-81) / 一時中断(waiting に遷移) |
beacon milestone release <id> |
Release occupation claim without changing status (ms-81) / 専有解除(active のまま) |
beacon milestone occupations [--ms <id>] [--json] |
List occupation event log (ms-81) / 専有イベント履歴一覧 |
beacon milestone show <id> [--json] |
Show details / 詳細表示 |
beacon milestone update <id> [options] |
Update fields / 更新 |
beacon milestone delete <id> |
Logical delete (cancelled) / 論理削除 |
beacon milestone purge <id> --reason "..." [--index <n>] |
Hard delete a milestone record — recovery for duplicate-ID corruption (Issue #14) / ハード削除(重複ID復旧用) |
beacon milestone rename <id> "new title" |
Rename milestone / 名前変更 |
beacon milestone depends <id> --on <id>[,id] |
Set dependencies / 依存関係設定 |
beacon milestone graph [--json] |
Show dependency graph / 依存グラフ表示 |
beacon milestone workspace <id> [--executor ai|human] |
Create git worktree for isolated development / worktree作成 |
beacon milestone workspace-cleanup <id> |
Remove worktree after work completes / worktree削除 |
Tasks & Entries
| Command | Description |
|---|---|
beacon task add "desc" [-m ms-id] [-t type] [-d detail] |
Add task to milestone / タスク追加 |
beacon task done <id> [-p progress] |
Mark as done / 完了 |
beacon task list [-m ms-id] [--json] |
List tasks / 一覧 |
beacon task show <id> [--json] |
Show details / 詳細 |
beacon task detail <id> [text] |
View/update detail / 詳細テキスト表示・更新 |
beacon task update <id> [options] |
Update fields / 更新 |
beacon task delete <id> |
Logical delete / 論理削除 |
beacon entry move <id> -t <task-id> |
Move entry under a task / タスク配下に移動 |
beacon entry purge <e-id> --reason "..." [--index <n>] |
Hard delete an entry record — recovery for duplicate-ID corruption (e-863) / ハード削除(重複ID復旧用) |
Pull Requests
| Command | Description |
|---|---|
beacon pr create [-m ms-id] [--intent "text"] [gh flags...] |
Run gh pr create and record the PR / PR作成+自動記録 |
beacon pr add <github-url> [-m ms-id] [--intent "text"] |
Register an existing PR / 既存PRを登録 |
beacon pr approve <entry-id> [--rationale "text"] |
Approve a PR (rationale required) / 承認 |
beacon pr request-changes <entry-id> [--rationale "text"] |
Request changes / 修正依頼 |
beacon pr reject <entry-id> [--rationale "text"] |
Reject a PR / 却下 |
beacon pr merge <entry-id> |
Mark as merged / マージ済みに設定 |
beacon pr close <entry-id> |
Close without merging / クローズ |
Use /review Claude Code Skill instead of beacon pr review for AI-assisted code review.
Deploy
| Command | Description |
|---|---|
beacon deploy record [--revision <rev>] [--semver <v1.0.0>] [--desc "text"] |
Record a deployment (auto major/minor detection) / デプロイ記録 |
beacon deploy list [--json] |
List deployment history / デプロイ履歴一覧 |
beacon deploy record automatically determines major (one or more milestones newly completed) vs minor (bug fix / patch to already-shipped milestones) based on commit history. The /beacon-deploy Skill wraps this with a two-phase prepare/finalize flow for AI-generated deploy descriptions.
Code Releases (Push Log)
| Command | Description |
|---|---|
beacon push record [--desc "text"] |
Record a git push (auto-collects commits since last push) / pushを記録 |
beacon push list [--json] |
List push history / push履歴一覧 |
The /beacon-push Skill wraps push recording with AI-generated value descriptions, triggered automatically by the PostToolUse hook after each git push.
GitHub Issues
| Command | Description |
|---|---|
beacon issue import <number> [-m ms-id] |
Import a GitHub Issue as a beacon task / IssueをBeaconタスクとして取り込み |
beacon issue sync [-m ms-id] |
Bulk import all open Issues not yet imported / 未インポートIssueを一括取り込み |
beacon issue list [--json] |
List open Issues not yet imported / 未インポートIssue一覧 |
Requires gh CLI authenticated. When a task linked to an Issue is marked done, beacon suggests closing the Issue via gh issue close.
Documents
| Command | Description |
|---|---|
beacon doc add "title" [--scope core|spec|memo] [--ms ms-id] [--op op-id] [--content text] |
Add document / ドキュメント追加 |
beacon doc list [--scope scope] [--ms ms-id] [--op op-id] [--json] |
List documents / 一覧 |
beacon doc show <doc-id> |
Show document / 内容表示 |
beacon doc update <doc-id> --content "text" |
Update document / 更新 |
beacon doc image-upload <local-file> |
Upload image, get markdown img tag / 画像アップロードして img タグを返す |
Scopes: core (design principles / 設計原則), spec (technical specs / 仕様), memo (notes / メモ)
Use --ms <ms-id> to associate a document with a milestone, or --op <op-id> to associate with an Operation (e.g. log fetch instructions for /beacon-operation-review).
Save (Non-commit actions)
| Command | Description |
|---|---|
beacon save "desc" -m ms-id [--source src] |
Record a non-commit action / コミット以外の行為を記録 |
beacon save "desc" -m ms-id --hash <hash> |
Link save to a related commit / 関連コミットに紐づけ |
beacon save "desc" --source google_docs --url "..." |
Record with external resource / 外部リソース付きで記録 |
Sources: manual (default, AI self-report), google_docs, notion, jupyter, or any custom string.
Logging
| Command | Description |
|---|---|
beacon log [message] [-m ms-id] |
Record HEAD commit to milestone / コミット記録 |
beacon log --prepare |
Output context as JSON (read-only) / 判断材料出力 |
beacon log --finalize --progress N |
Write evaluation results / 評価結果書き込み (--summary was retired in e-1040 — see project-vision doc + session log) |
beacon summary [--json] |
View project summary (read-only). Writes retired in e-1040 — use project-vision doc + beacon session log |
beacon sync |
Auto-sync recent commits / 直近コミットを同期 |
beacon search <query> [-m ms-id] [--json] |
Full-text search across milestones, tasks, commits, PRs, and saves / 全文検索 |
Operations
Operations track recurring operational workloads (daily batch jobs, incident management) — the "maintenance" layer alongside development Milestones.
| Command | Description |
|---|---|
beacon operation open "title" [--schedule daily|weekdays|weekly] [--log-source name] |
Start a new Operation cycle / 新しいOperationを開始 |
beacon operation close <op-id> |
Close an Operation cycle / クローズ |
beacon operation purge <op-id> --reason "..." [--index <n>] |
Hard delete an operation record — recovery for duplicate-ID corruption (e-863) / ハード削除(重複ID復旧用) |
beacon operation list [--json] |
List Operations / 一覧 |
beacon operation show <op-id> [--json] |
Show Operation with entries + active envelope / 詳細表示(有効な envelope 含む) |
beacon operation approve <op-id> --spec <doc-id> [--expires-at YYYY-MM-DD] [--json] |
Mint T2 envelope from SPEC doc's approved_actions (ms-60) / SPEC ドキュメントの許可 action 一覧から T2 envelope を発行 |
beacon operation revoke <op-id> [--envelope-id ENV] [--reason TEXT] [--json] |
Invalidate the active envelope (or a specific one) / 有効な envelope を無効化 |
beacon operation envelope verify <op-id> <action> [--json] |
AI self-check used by /beacon-operation-execute — is the action permitted by the active envelope? (ms-60 / e-1340) / 指定 action が envelope の許可範囲か判定 |
beacon run record -o <op-id> --batch <name> --status ok|warning|error --desc "..." |
Record a batch run result / バッチ実行結果を記録 |
beacon run list -o <op-id> [--json] |
List run records / 実行記録一覧 |
beacon incident open "title" -o <op-id> [--desc "..."] |
Open an incident / インシデント起票 |
beacon incident close <id> --resolution "..." |
Resolve an incident / インシデント解決 |
beacon incident escalate <id> -m <ms-id> |
Escalate incident to a Milestone task / Milestoneタスクに昇格 |
The /beacon-operation-setup Skill walks through setup conversationally and auto-generates a SPEC document (log fetch instructions). The /beacon-operation-review Skill reads that SPEC, fetches logs, interprets them, and records the result — triggered automatically by operation_check_<op-id> triggers at session start.
Treks
Treks (= 協奏作業領域) are cross-project, cross-session work areas. While a Milestone lives inside one project, a trek bundles work that spans several projects (and several teammates' sessions) — for example "v0.35.0 release rehearsal across Beacon + PE + LPS" or "Daily cross-team standup" — and keeps members, scope (= work items in / out of focus), live status, and halt (= Andon cord) state in one place. CLI / Web UI / Tauri Desktop all see the same trek, so a CLI user and a Web UI user can co-drive without diverging.
| Command | Description |
|---|---|
beacon trek create "title" [--type temporary|persistent] [--description "..."] [--goal-state "<criterion>"] |
Create a trek; caller becomes leader. --goal-state (ms-75 / e-1865) は完了マーカー (acceptance_criteria 相当) |
beacon trek list [--status s] [--include-archived] [--all-actors] [--joined] [--json] |
List treks visible to the caller. --joined で自分が join 済の trek だけに絞る (ms-75 / e-1813) |
beacon trek show <trek-id> [--all] [--json] |
Trek 詳細 + scope に紐付く task / commit / 配下 doc の集約ビュー (ms-75 / e-1864)。--all で要約 cap を解除 |
beacon trek timeline <trek-id> [--limit N] [--json] |
Trek の lifecycle / scope 内 commit / task done / 配下 doc を時系列で参照 (ms-75 / e-1867) |
beacon trek start <trek-id> |
Transition planning → active / planning から active へ |
beacon trek archive <trek-id> |
Archive (= terminal); restart by creating a new trek / 完了化、再開は新 trek 起票 |
beacon trek invite <trek-id> --actor <email> [--notify] |
Invite a user by email; --notify sends a live DM (--notify is acknowledged but live DM lands later) / メンバー招待 |
beacon trek join <trek-id> |
Accept own invitation / 招待を accept |
beacon trek leave <trek-id> |
Remove self (leader must transfer-leader first; last member must archive instead) / 離脱 |
beacon trek plan <trek-id> --add-scope <project:ref> |
Add a scope entry (ms-X / op-X / e-X ref, or omit for project-wide) / scope 追加 |
beacon trek plan <trek-id> --remove-scope <project:ref> |
Remove a scope entry / scope 削除 |
beacon trek plan <trek-id> --goal-state "<criterion>" |
Trek の完了マーカーを設定 (空文字で clear、ms-75 / e-1865) |
beacon trek stop <trek-id> [--reason "..."] |
Pull the Andon cord (= halt signal, sessions pause) / 非常停止 |
beacon trek resume <trek-id> |
Clear the halt signal / 再開 |
beacon trek transfer-leader <trek-id> --to <session-id> |
Hand off leader_session_id to another session / leader 引き継ぎ |
beacon trek take-over <trek-id> |
Re-bind leader_session_id to a fresh session of the same leader user (= dead-session recovery without the prior leader's authorization, ms-88 e-2089) |
In the Web UI / Tauri Desktop, the Treks tab on a project page lists every trek that includes the current project in its scope (= active と archived を別表示)。各 trek の詳細では members / scope / status / 関連 docs が並ぶ。逆に milestone / operation / task の詳細を開くと、その作業項目を scope に含む trek 一覧が Related Treks widget としてインラインで出る。
Trek の作成・編集・状態遷移はすべて CLI から。Web UI は閲覧と監査 (= 誰が何を見ているか・どこで halt がかかっているか) に専念し、ユーザーをターミナルに戻さない。
Session Notes
Ephemeral memos that survive context compaction within a session — cleared at session end.
| Command | Description |
|---|---|
beacon note "text" [--context "label"] |
Add a session note / セッションメモ追加 |
beacon note list [--json] |
Show session notes / メモ一覧 |
beacon note clear |
Clear all session notes / 全削除 |
Say "メモして" or "remember this" and Claude will call /beacon-note automatically. At session end, /beacon-session-end prompts to promote important notes to permanent Documents before clearing.
Retrospectives
| Command | Description |
|---|---|
beacon retro [--since DATE] [--until DATE] |
Generate weekly retro data / 週次振り返りデータ生成 |
beacon retro done |
Mark current retro as reviewed / 振り返りレビュー済み |
Triggers
| Command | Description |
|---|---|
beacon trigger fire <name> [message] |
Fire a trigger (used by dashboard) / トリガー発火 |
beacon trigger check |
Check pending triggers (JSON) / 未処理トリガー確認 |
beacon trigger clear <name> |
Clear a specific trigger / トリガー消化 |
DM Channel (multi-session messaging)
Manage the beacon-bus MCP channel that powers parallel-session DM. See
docs/getting-started-dm.md for the full
walkthrough.
| Command | Description |
|---|---|
beacon channel install |
Install beacon-bus MCP entry into .mcp.json / DM 機能を有効化 |
beacon channel uninstall [--purge-files|--keep-files] |
Remove MCP entry; --purge-files also moves channel/node_modules to .trash/ |
beacon channel opt-out [--project|--global] |
Block install / auto-install (persistent flag) |
beacon channel opt-in [--project|--global] |
Lift the opt-out flag |
beacon channel status |
Show install / files / opt-out / next-action state |
bclaude (shipped alongside beacon in Homebrew) launches Claude Code
with the channel pre-wired, and falls back to plain claude when any
opt-out source is active.
Coordination signals (ms-55)
The "走る / 止まる両輪" surface for parallel autonomous sessions:
STOP anyone can broadcast a halt, rollback undoes the safe local
portion, claim coordinates who's taking what, stuck escalates
idle timeouts, and morning is the next-day digest. See
SPEC bnzTXhu6KYIMfVE2Ivy2 for the full
design.
| Command | Description |
|---|---|
beacon stop scoped <target> [--kind ms|task|session] [--reason-kind <k>] [--reason <text>] |
Broadcast STOP at one MS / task / session (Andon cord — anyone can halt) |
beacon stop global [--reason-kind <k>] [--reason <text>] |
Broadcast STOP across every active autonomous session |
beacon stop status [--json] |
Show the latest stop / resume state from the stop-signal channel |
beacon resume scoped <target> [--kind ms|task|session] [--reason <text>] |
Clear a scoped STOP, allowing targeted session(s) to resume |
beacon resume global [--reason <text>] |
Clear a global STOP |
beacon rollback [--commits N] [--reason <text>] [--dry-run] [--no-record] |
Undo working tree (git stash) + N local commits (--soft reset); past upstream → report + compensation proposals only |
beacon claim request <kind>:<id> [--intent <text>] |
Announce intent to take a target (ms/task/operation/trek/free) |
beacon claim respond <claim-id> [--accept|--reject] [--reason <text>] |
Respond to another session's claim request |
beacon claim post <kind>:<id> [--intent <text>] |
Post-hoc record (no request/response dance) |
beacon claim handoff <claim-id> --to <session> [--reason <text>] |
Transfer an active claim to another session |
beacon claim release <claim-id> [--outcome completed|abandoned] [--reason <text>] |
Release a claim (outcome surfaces in beacon morning) |
beacon claim list [--json] |
List active claims from local .beacon/active_claims.json |
beacon stuck check [--telemetry-file <path>] [--idle-min N] |
Detect sessions idle past --idle-min; emit STUCK signals so beacon morning surfaces 介入要望 |
beacon morning [--since-hours N] [--events-file <path>] [--no-doc] [--json] |
4-bucket digest (完了 / 停止 / skip / 介入要望); auto-saves as a scope=report doc |
Dashboard
Beacon's visual UI is split across two front-ends:
- Tauri Desktop App — cross-platform native window for monitoring milestones, tasks, and entries.
- Web UI — browser-based dashboard for cloud-linked projects (after
beacon cloud push).
The legacy curses dashboard (lib/dashboard.py, tmux split-pane) was retired in e-764 and archived to .trash/lib-dashboard-py-e764/. The bare beacon command now prints status plus pointers to the two supported UIs.
Claude Code Integration
Beacon ships with Claude Code Skills for automated project tracking. beacon setup installs them automatically; you can also run beacon skill install at any time to update.
| Skill | Description |
|---|---|
beacon-session-start |
Restore project context at session start / セッション開始時にコンテキスト復元 |
beacon-log |
Record commits with AI-evaluated progress and summary / コミット記録+AI進捗評価 |
beacon-task |
Task CRUD operations / タスク操作 |
beacon-session-end |
Update summary and organize open tasks / サマリー更新+未完了整理 |
beacon-deploy |
Record a deployment with AI-generated description / AI説明付きデプロイ記録 |
beacon-push |
Record a git push with AI-generated value description / AI説明付きpush記録 |
beacon-retro |
Generate and discuss weekly retrospective / 週次振り返りドキュメント生成 |
beacon-dispatch |
Identify executable milestones and launch parallel sub-agents / 並列サブエージェント起動 |
beacon-init |
Conversational project initialization with Project Archaeology / 会話形式プロジェクト初期化 |
beacon-note |
Record an ephemeral session memo (auto-triggered by "メモして") / セッションメモ記録 |
beacon-operation-setup |
Conversational Operation setup with auto-generated SPEC doc / 会話形式でOperation作成+SPEC自動生成 |
beacon-operation-review |
Fetch logs per SPEC, interpret, and record run result / SPECに従いログ取得→解釈→run record記録 |
beacon-spec |
Conversational SPEC (requirements / decision trail) authoring + task breakdown / 対話駆動SPEC作成+タスク一括起票 |
beacon-retrospect |
Query project history in natural language ("did we build X? how?") / プロジェクト史を自然言語で検索 |
beacon-vision |
Refine a fuzzy idea into a structured project vision (CORE doc) / ふわっとした構想をビジョンに精緻化 |
beacon-roadmap |
Design a set of milestones (3–7) toward the project vision / 大目的に向けたマイルストーン群を設計 |
beacon-pr-create |
Conversational PR creation (intent capture + branch/commit checks) / 対話形式でPR作成 |
beacon-incident-report |
Close an incident and save a cause/response/prevention report / インシデントclose+レポート作成 |
Two-phase workflow
Skills use a prepare/finalize pattern to keep AI judgment structured:
beacon log --prepare(orbeacon deploy record --prepare,beacon push record --prepare) outputs context as JSON- The Skill prompts Claude to generate a summary, deploy description, or push description
beacon log --finalize(orbeacon deploy record --finalize,beacon push record --desc "...") writes the result
This design ensures AI-generated content is channeled through deterministic CLI operations, not free-form file edits.
Desktop App
Beacon includes a native desktop application built with Tauri for local, cross-platform project monitoring without a browser.
cd desktop
npm install
npm run tauri dev # Development
npm run tauri build # Production (.app/.dmg on macOS)
The Desktop App uses the same beacon CLI as its backend and supports both local and cloud projects. It features the same tabs as the Web UI: Milestones, Graph, Reviews, and Documents.
Data Model
All project state lives in .beacon/project.json. See SPEC.md for the full schema.
.beacon/
project.json # Project state (milestones, entries, summary)
config.json # Mode config: local or cloud
cloud.json # Cloud project binding (project_id, api_url)
documents/ # Project documents (Markdown with YAML frontmatter)
retro/ # Weekly retrospective documents
triggers/ # Async message queue (dashboard <-> Claude Code)
Doc & Skill auto-sync scope (ms-10 e-722)
To prevent doc drift, three guards run automatically (pre-commit hook + CI
lint-docs workflow):
| Guard | What it checks |
|---|---|
scripts/check-skill-drift.py |
skills/*.md in the repo matches ~/.claude/skills/<name>/SKILL.md. Repair: beacon skill install (or set BEACON_AUTO_SKILL_INSTALL=1 to auto-run from the hook). Also surfaced by beacon doctor check #6. |
scripts/check-cli-help-drift.py |
The set of (subcommand, subsubcommand) pairs is consistent across bin/beacon usage, cmd_help_json (beacon help --json), and the README ## CLI Commands tables. Intentional asymmetries are listed inline as allowlists. |
scripts/check-install-md.py |
INSTALL.md bash blocks don't use deprecated flags (e.g. gcloud run deploy --build-arg — gcloud wants --set-build-env-vars). Brew / pipx commands have a package positional. |
Explicitly out of scope (these still need a human reviewer):
- Whether a CLI flag's description text is accurate — the guard only
checks that the flag exists in
--help, not what it means. - Whether the README's prose paragraphs (Why Beacon?, Quick Start, etc.) reflect the latest behavior — only the CLI tables are diffed.
- Skill body content review — drift detection only catches "you forgot to
run
beacon skill install", not "this Skill's instructions became wrong".
Catch-up sweeps (manual doc audits) are still useful when the scope above misses something, but the day-to-day drift surface should now stay clean by construction.
License
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file beacon_ai-0.48.0.tar.gz.
File metadata
- Download URL: beacon_ai-0.48.0.tar.gz
- Upload date:
- Size: 1.2 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f6f160d0f8cb613e8abb7915b3183d8ed831a8139226069af8d9ebc2a72c6f5b
|
|
| MD5 |
f28892d58d8811e476f96cd6b79e6b1f
|
|
| BLAKE2b-256 |
2f0680072b0c239f2e4339e72be2ebc715679eba6e02b4a22e7201d5184a065a
|
Provenance
The following attestation bundles were made for beacon_ai-0.48.0.tar.gz:
Publisher:
release-build.yml on kurogin23mech-source/beacon
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
beacon_ai-0.48.0.tar.gz -
Subject digest:
f6f160d0f8cb613e8abb7915b3183d8ed831a8139226069af8d9ebc2a72c6f5b - Sigstore transparency entry: 1906660460
- Sigstore integration time:
-
Permalink:
kurogin23mech-source/beacon@07b5a79237833c3a9b3714d190a3da0ced3ff687 -
Branch / Tag:
refs/tags/v0.48.0 - Owner: https://github.com/kurogin23mech-source
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release-build.yml@07b5a79237833c3a9b3714d190a3da0ced3ff687 -
Trigger Event:
workflow_dispatch
-
Statement type:
File details
Details for the file beacon_ai-0.48.0-py3-none-any.whl.
File metadata
- Download URL: beacon_ai-0.48.0-py3-none-any.whl
- Upload date:
- Size: 769.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
710305de1860cdb82fae6c1c2f4ad8899965a1f7b42b1410e24bd3aca2c3e1e2
|
|
| MD5 |
c6435e9976bcd788c548af0c12999aa3
|
|
| BLAKE2b-256 |
f572c3338f1864a32861a4150c8a08649959554362942178c23bb3cf9b469075
|
Provenance
The following attestation bundles were made for beacon_ai-0.48.0-py3-none-any.whl:
Publisher:
release-build.yml on kurogin23mech-source/beacon
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
beacon_ai-0.48.0-py3-none-any.whl -
Subject digest:
710305de1860cdb82fae6c1c2f4ad8899965a1f7b42b1410e24bd3aca2c3e1e2 - Sigstore transparency entry: 1906660539
- Sigstore integration time:
-
Permalink:
kurogin23mech-source/beacon@07b5a79237833c3a9b3714d190a3da0ced3ff687 -
Branch / Tag:
refs/tags/v0.48.0 - Owner: https://github.com/kurogin23mech-source
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release-build.yml@07b5a79237833c3a9b3714d190a3da0ced3ff687 -
Trigger Event:
workflow_dispatch
-
Statement type: