# CLI reference

Every `bob` command, generated from the same help text `bob --help` prints.

## Daily workflow

| Command | What it does |
| --- | --- |
| [`bob capture`](<https://bobs-org.github.io/reference/cli/capture/index.md>) | Capture tasks, bullets, and Pomodoro commands into the vault |
| [`bob freshness`](<https://bobs-org.github.io/reference/cli/freshness/index.md>) | Walk the tiered freshness review queue |
| [`bob plan`](<https://bobs-org.github.io/reference/cli/plan/index.md>) | Show today's plan budget, Today's tasks, and NEXT/PENDING lanes |
| [`bob pomodoro`](<https://bobs-org.github.io/reference/cli/pomodoro/index.md>) | Show Pomodoro status, print the tmux line, or notify on completion |
| [`bob pomodoro notify`](<https://bobs-org.github.io/reference/cli/pomodoro/#bob-pomodoro-notify>) | Notify when the current Pomodoro is complete |
| [`bob pomodoro status`](<https://bobs-org.github.io/reference/cli/pomodoro/#bob-pomodoro-status>) | Show the current Pomodoro status (default) |
| [`bob pomodoro tmux`](<https://bobs-org.github.io/reference/cli/pomodoro/#bob-pomodoro-tmux>) | Print the Pomodoro status and plan meter for tmux |
| [`bob ready`](<https://bobs-org.github.io/reference/cli/ready/index.md>) | Show each area/project note's Ready lane against the per-note cap |
| [`bob stats`](<https://bobs-org.github.io/reference/cli/stats/index.md>) | Show derived daily metrics as a glance, detail chart, or catalog |
| [`bob stats metrics`](<https://bobs-org.github.io/reference/cli/stats/#bob-stats-metrics>) | List metric ids, kinds, and definitions |
| [`bob stats overview`](<https://bobs-org.github.io/reference/cli/stats/#bob-stats-overview>) | Show the weekly glance (default) |
| [`bob stats show`](<https://bobs-org.github.io/reference/cli/stats/#bob-stats-show>) | Show one or more metrics in detail |
| [`bob themes`](<https://bobs-org.github.io/reference/cli/themes/index.md>) | List, hide, unhide, color, and rename Pomodoro themes |
| [`bob themes color`](<https://bobs-org.github.io/reference/cli/themes/#bob-themes-color>) | Pin or unpin a theme's hue |
| [`bob themes hide`](<https://bobs-org.github.io/reference/cli/themes/#bob-themes-hide>) | Hide themes from Recent suggestion rows |
| [`bob themes list`](<https://bobs-org.github.io/reference/cli/themes/#bob-themes-list>) | List remembered Pomodoro themes (default) |
| [`bob themes rename`](<https://bobs-org.github.io/reference/cli/themes/#bob-themes-rename>) | Rename a Pomodoro theme everywhere in one commit |
| [`bob themes unhide`](<https://bobs-org.github.io/reference/cli/themes/#bob-themes-unhide>) | Show hidden themes in Recent suggestion rows again |

## Tasks and projects

| Command | What it does |
| --- | --- |
| [`bob projects`](<https://bobs-org.github.io/reference/cli/projects/index.md>) | List and sync project notes via their ^prj tasks |
| [`bob relations`](<https://bobs-org.github.io/reference/cli/relations/index.md>) | List, hide, unhide, and rename relation labels |
| [`bob relations hide`](<https://bobs-org.github.io/reference/cli/relations/#bob-relations-hide>) | Hide relation labels from suggestions |
| [`bob relations list`](<https://bobs-org.github.io/reference/cli/relations/#bob-relations-list>) | List relation labels in the vault (default) |
| [`bob relations rename`](<https://bobs-org.github.io/reference/cli/relations/#bob-relations-rename>) | Rename a relation label everywhere in one commit |
| [`bob relations unhide`](<https://bobs-org.github.io/reference/cli/relations/#bob-relations-unhide>) | Show hidden relation labels in suggestions again |
| [`bob task`](<https://bobs-org.github.io/reference/cli/task/index.md>) | Vault-wide task maintenance: archive, move, reconcile, reroll |
| [`bob task archive`](<https://bobs-org.github.io/reference/cli/task/#bob-task-archive>) | Move done and canceled tasks into done/ archives and repair links |
| [`bob task move`](<https://bobs-org.github.io/reference/cli/task/#bob-task-move>) | Move open tasks between notes and repair vault links |
| [`bob task reconcile`](<https://bobs-org.github.io/reference/cli/task/#bob-task-reconcile>) | Reconcile task statuses from the Pomodoro ledger and dependencies |
| [`bob task reroll`](<https://bobs-org.github.io/reference/cli/task/#bob-task-reroll>) | Re-roll due prioritized tasks within their priority windows |

## Vault

| Command | What it does |
| --- | --- |
| [`bob articles`](<https://bobs-org.github.io/reference/cli/articles/index.md>) | Format and inspect article notes with bob-owned section numbers |
| [`bob nightly`](<https://bobs-org.github.io/reference/cli/nightly/index.md>) | Run nightly maintenance: vault-sync, task archive, articles, vault-sync |
| [`bob query`](<https://bobs-org.github.io/reference/cli/query/index.md>) | Run Dataview or Tasks queries against the vault |
| [`bob ref`](<https://bobs-org.github.io/reference/cli/ref/index.md>) | Find, list, read, rename, and plan references for today; sync Highlights PDFs into them |
| [`bob vault-sync`](<https://bobs-org.github.io/reference/cli/vault-sync/index.md>) | Reconcile the vault through Git (default: run) or show status |

## Integrations

| Command | What it does |
| --- | --- |
| [`bob gkeep`](<https://bobs-org.github.io/reference/cli/gkeep/index.md>) | Drain the Google Keep inbox into Obsidian tasks |

## Setup

| Command | What it does |
| --- | --- |
| [`bob completion`](<https://bobs-org.github.io/reference/cli/completion/index.md>) | Install and inspect shell completion for bob |
| [`bob plugins`](<https://bobs-org.github.io/reference/cli/plugins/index.md>) | List and deploy Bob's custom Obsidian plugins |

## Capture protocol

| Command | What it does |
| --- | --- |
| [`bob capture-complete`](<https://bobs-org.github.io/reference/cli/capture-complete/index.md>) | Complete the capture marker at the cursor |
| [`bob capture-parse`](<https://bobs-org.github.io/reference/cli/capture-parse/index.md>) | Explain what in-progress capture text currently means |
| [`bob capture-pomodoro-name`](<https://bobs-org.github.io/reference/cli/capture-pomodoro-name/index.md>) | Write a name onto an open unnamed Pomodoro |
| [`bob capture-pomodoros`](<https://bobs-org.github.io/reference/cli/capture-pomodoros/index.md>) | List today's Pomodoro ledger entries |
| [`bob capture-related`](<https://bobs-org.github.io/reference/cli/capture-related/index.md>) | List existing tasks that a new capture may duplicate |
| [`bob capture-rewrite`](<https://bobs-org.github.io/reference/cli/capture-rewrite/index.md>) | Apply the capture grammar's automatic draft rewrites |
| [`bob capture-sections`](<https://bobs-org.github.io/reference/cli/capture-sections/index.md>) | List the non-Tasks sections of a capture note |
| [`bob capture-targets`](<https://bobs-org.github.io/reference/cli/capture-targets/index.md>) | List inbox, area, and active project capture routes |
| [`bob capture-task-id`](<https://bobs-org.github.io/reference/cli/capture-task-id/index.md>) | Write a block ID onto an open capture task |
| [`bob capture-task-sections`](<https://bobs-org.github.io/reference/cli/capture-task-sections/index.md>) | List the ALL-CAPS child sections of a capture task |
| [`bob capture-tasks`](<https://bobs-org.github.io/reference/cli/capture-tasks/index.md>) | List the open tasks of a capture note |
| [`bob capture-templates`](<https://bobs-org.github.io/reference/cli/capture-templates/index.md>) | List, save, show, and manage saved capture templates |
| [`bob capture-templates clear`](<https://bobs-org.github.io/reference/cli/capture-templates/#bob-capture-templates-clear>) | Clear the saved-template shelf |
| [`bob capture-templates delete`](<https://bobs-org.github.io/reference/cli/capture-templates/#bob-capture-templates-delete>) | Delete templates by list index or content id |
| [`bob capture-templates list`](<https://bobs-org.github.io/reference/cli/capture-templates/#bob-capture-templates-list>) | List saved capture templates (default) |
| [`bob capture-templates save`](<https://bobs-org.github.io/reference/cli/capture-templates/#bob-capture-templates-save>) | Save a template definition without capturing a row |
| [`bob capture-templates show`](<https://bobs-org.github.io/reference/cli/capture-templates/#bob-capture-templates-show>) | Print one template as a ready-to-insert draft |

## Full help

bob --help

```
Bob tracks a daily Pomodoro ledger inside an Obsidian vault and keeps that
vault synced through Git. Commands follow the daily workflow: capture, review
(plan, freshness, ready), stats, run Pomodoros, reconcile tasks, and nightly
maintenance. Pass `--help` to any command, or run `bob help <command>`, for
its own options.

Usage: bob <COMMAND>

Daily workflow:
  capture     Capture tasks, bullets, and Pomodoro commands into the vault
  freshness   Walk the tiered freshness review queue
  plan        Show today's plan budget, Today's tasks, and NEXT/PENDING lanes
  pomodoro    Show Pomodoro status, print the tmux line, or notify on completion
  ready       Show each area/project note's Ready lane against the per-note cap
  stats       Show derived daily metrics as a glance, detail chart, or catalog
  themes      List, hide, unhide, color, and rename Pomodoro themes

Tasks and projects:
  projects    List and sync project notes via their ^prj tasks
  relations   List, hide, unhide, and rename relation labels
  task        Vault-wide task maintenance: archive, move, reconcile, reroll

Vault:
  articles    Format and inspect article notes with bob-owned section numbers
  nightly     Run nightly maintenance: vault-sync, task archive, articles,
              vault-sync
  query       Run Dataview or Tasks queries against the vault
  ref         Find, list, read, rename, and plan references for today; sync
              Highlights PDFs into them
  vault-sync  Reconcile the vault through Git (default: run) or show status

Integrations:
  gkeep       Drain the Google Keep inbox into Obsidian tasks

Setup:
  completion  Install and inspect shell completion for bob
  plugins     List and deploy Bob's custom Obsidian plugins

Capture protocol:
  capture-complete       Complete the capture marker at the cursor
  capture-parse          Explain what in-progress capture text currently means
  capture-pomodoro-name  Write a name onto an open unnamed Pomodoro
  capture-pomodoros      List today's Pomodoro ledger entries
  capture-related        List existing tasks that a new capture may duplicate
  capture-rewrite        Apply the capture grammar's automatic draft rewrites
  capture-sections       List the non-Tasks sections of a capture note
  capture-targets        List inbox, area, and active project capture routes
  capture-task-id        Write a block ID onto an open capture task
  capture-task-sections  List the ALL-CAPS child sections of a capture task
  capture-tasks          List the open tasks of a capture note
  capture-templates      List, save, show, and manage saved capture templates

Options:
  -h, --help
          Print help (see a summary with '-h')

  -V, --version
          Print version

Examples:
  bob capture buy milk @groceries   Capture a task into groceries.md
  bob capture '='                   Start the queued Pomodoro
  bob plan                          Show today's plan budget and lanes
  bob freshness                     List the review queue
  bob ready                         Show Ready lanes against the per-note cap
  bob stats                         Glance at derived daily metrics
  bob themes                        List recently used Pomodoro themes
  bob task reconcile --dry-run      Preview task status reconciliation
  bob query --source '#project'     Print matching note paths
  bob vault-sync status --json      Print the last vault Git sync status

Run 'bob <command> --help' or 'bob help <command>' for more on a command.
```