Contracts¶
These pages specify behavior that Bob components and their tests must agree on.
Capture and integrations¶
- Article notes —
bob articlesformatting, list, outline, adopt, and ArticlePlan JSON - Capture — Capture grammar, JSON, and picker commands (
bob capture, parse, complete, discovery) - Shell completion — Shell completion: the runtime model, protocol 1, and what completes
- Getting started — Vault requirements, first capture/session, command effects, and troubleshooting
- Bob Gkeep —
bob gkeepKeep inbox drain into tasks or inline reference clips - Web article capture (
bob ref create <URL> [<URL>…]) — Web article and collection capture into Highlights intake PDFs bob ref create— vault notes, Markdown, PDF, and URL targets —bob ref createvault-note snapshots, Markdown, PDFs, and URL collections- Highlights Reference Note Sync —
bob refPDF intake and reference notes - Bob Plugins —
bob pluginslist and vault deploy
Tasks and projects¶
- Dashboard navigation and child pages — Dashboard Review / Work / Browse navigation and collection pages
- Task date marks — Task date marks: calendar-label display contract for canonical task dates and recurrence rules
- Task freshness — Task review queue, confirmation dates, recurring occurrences, returning tasks (ticklers), and JSON schema 14
- Plan budget, Today, and lanes — Plan budget, Today, and lanes definition,
bob planJSON, lints, and conformance examples - Project Task Sync —
bob projects^prjlifecycle, schedules, and reporting-only rollup - Pomodoro homes — Derived Pomodoro homes, rollup, labels, chips, hues, and JSON contract
- Pomodoro themes — Pomodoro theme catalog, hues, hide journal,
bob themes, and JSON - Randomize —
bob task rerollbulk re-roll of due prioritized tasks - Daily Stats — Daily Stats metrics,
bob stats, JSON, the v1 review journal, and the Obsidian Stats page - Task dependency links — Task dependency links: Depends-On line, BLOCKS mirror, successor offers, project-dependency contract, plus conformance vectors
- Task relations — Task relations: directed LINKS edges, the generated LINKED FROM mirror, and
~/~~capture - Move open tasks between notes —
bob task moveselection, preservation, link repair, guarded writes, and sync behavior - Task Status Hooks —
bob task reconcilePomodoro-driven task status - Task tag marks — Task tag marks: the teal hash glyph that replaces the
#taskpill - Today marks — Today marks: a display-only tomato on task lines linked under today's open Pomodoros
References¶
- bob query —
bob queryDataview and Tasks - Reference library (
bob ref) — Reference lookup, reading state, the Obsidian Reading Board, Today linking, renaming, JSON, and migration/rollback - Ref jobs (
bob ref jobs) —bob ref jobsbackground capture progress, worker, fallback, and recovery
Vault¶
- Obsidian Sync folder exclusions (historical) — Historical: Obsidian Sync folder-exclusion semantics, kept for reference now that the vault syncs through git only
- Bob vault Git sync runbook — Git-only Bob vault sync operations, triggers, conflict copies, Keep receipts, and the Stats review journal