Add visual README and universal agent init
Merged
DA
6mo ago+4955+4955+0123456789012345678901234567890123456789-131-131-012345678901234567890123456789
Summary
- Adds
braid agent-initas the universal activation command for Claude, Codex, Cursor, and Copilot. - Rewrites the public README as a GitHub-ready technical landing page.
- Adds editable Excalidraw sources plus SVG exports for memory boundaries, agent activation, and retrieval flow.
Test Plan
- Validated README image links and parsed all Excalidraw/SVG assets.
-
PYTHONPATH=src .venv/bin/python -m pytest -q -
PYTHONPATH=src .venv/bin/python -m braid.cli --help -
braid agent-init --check --json -
rg -n "wikiforge|fairlead" README.mdonly shows explicit legacy alias note. -
git diff --check -
git diff --cached --check
Summary by cubic
Adds a universal braid agent-init across Claude, Codex, Cursor, and Copilot, plus braid doctor, status --json, a new braid patterns playbook, and Obsidian export. Replaces the README with a visual, GitHub-ready landing page and updated diagrams.
-
New Features
braid agent-initwith--agent,--check,--fix,--remove,--json. Idempotent; no indexing; respects nearest project boundary. Sets Claude SessionStart hook + MCP (braid mcp-serve), Codex session hook, and Cursor/Copilot discovery symlinks.braid claude-initnow delegates.- Diagnostics:
braid doctor [--json] [--fix]checks install, context, agents, secrets, and drift.braid status --jsonemits a stable payload. Config hardening preserves invalid JSON instead of overwriting. - Playbook:
braid patterns [--json]exposes the operational patterns read-only, aligned with the new diagrams. - Wiki export:
braid wiki build --obsidiancreates an Obsidian vault in.braid/wiki/obsidian/or writes to--vault(underBraid/<dataset_id>/). Supports--outputfor a fresh vault. - Docs/CI: visual README with refreshed diagrams (agent activation, memory boundaries, retrieval flow, operational patterns). CI validates README assets and uses
actions/checkout@v6,actions/setup-python@v6on Python 3.11. ADR 0017/0018/0019/0020 included. Tests cover drift detection, fix/remove, boundary resolution, JSON outputs, patterns, and Obsidian export. - DuckLake: SQL formatting fix for Python 3.11 and auto-install of DuckDB FTS in clean environments.
-
Migration
- Run
braid agent-init --fixin each repo to normalize hooks, MCP, and discovery symlinks. - Use
braid agent-init --check --jsonand/orbraid doctor --jsonin CI to detect drift;--removeuninstalls only Braid-managed blocks. - Optional: export memory to Obsidian with
braid wiki build --obsidian.
- Run
Summary by CodeRabbit
-
New Features
- Added
braid agent-init(apply/check/fix/remove) with--jsonand backward-compatibleclaude-initdelegation. - New CLI commands:
braid doctor(diagnostics, optional--fix/--json),braid status --json, andbraid patterns [--json]. braid wikigains Obsidian vault export mode (--obsidian,--vault/--outputhandling).
- Added
-
Documentation
- Expanded README and added diagrams for agent activation, memory boundaries, retrieval flow, and operational patterns.
-
Tests & CI
- New test suites for agent-init, doctor/status/patterns/wiki workflows and CI pipeline validating docs, tests, and CLI smoke checks.