Skip to content

bob stats

Show derived daily metrics as a glance, detail chart, or catalog

bob stats --help
Show derived daily metrics as a glance, detail chart, or catalog

The command is read-only. Bare `bob stats` runs overview.

Usage: bob stats [COMMAND]

Commands:
  metrics   List metric ids, kinds, and definitions
  overview  Show the weekly glance (default)
  show      Show one or more metrics in detail

Options:
  -h, --help  Print help

Bare `bob stats` runs the read-only overview glance.

Examples:
  bob stats                    Weekly glance of the overview metrics
  bob stats -r 7d -c           Last 7 days, with the prior period
  bob stats show worked -c     Detail chart for Worked, with prior ticks
  bob stats show -a -f json    Every visible metric as one JSON object
  bob stats metrics            The metric catalog

See docs/stats.md for the catalog, JSON contract, and display rules.
Run 'bob stats <command> --help' for more information on a command.

bob stats metrics

List metric ids, kinds, and definitions

bob stats metrics --help
List every visible metric: id, label, kind, unit, source, origin, since, and a dim definition line. JSON prints full definitions and parameters without points. The command is read-only. See docs/stats.md.

Usage: bob stats metrics [OPTIONS]

Options:
  -b, --bob-dir <DIR>
          Bob vault root; defaults to BOB_DIR or ~/bob

  -f, --format <FORMAT>
          Output format: human or json

          [default: human]
          [possible values: human, json]

  -h, --help
          Print help

Examples:
  bob stats metrics
  bob stats metrics -f json

Environment:
  BOB_CONFIG_FILE  Exact Bob config file; defaults to ~/.config/bob/config.yml
  BOB_DIR          Bob vault root when --bob-dir is omitted
  BOB_NOW          Local datetime override that pins today for the report
  NO_COLOR         Disable colored output

Exit codes:
  0  report
  1  vault I/O failure
  2  usage, unknown metric, config error, or non-Dataview task format

See docs/stats.md for the catalog, JSON contract, and display rules.

bob stats overview

Show the weekly glance (default)

bob stats overview --help
Show the weekly glance of overview metrics as sparklines, today's in-progress values, and journal health. Bare `bob stats` runs this command. The command is read-only. See docs/stats.md for the catalog and display rules.

Usage: bob stats overview [OPTIONS]

Options:
  -b, --bob-dir <DIR>
          Bob vault root; defaults to BOB_DIR or ~/bob

  -c, --compare
          Include the prior period's points

  -f, --format <FORMAT>
          Output format: human, json, or csv

          [default: human]
          [possible values: human, json, csv]

  -g, --group <GROUP>
          Bucket points by auto, day, week, or month

          [default: auto]
          [possible values: auto, day, week, month]

  -h, --help
          Print help

  -o, --offset <N>
          Shift the window back this many ranges

  -r, --range <RANGE>
          Window as 7d, 4w, 3m, 1y, all, or START..END

Examples:
  bob stats
  bob stats -r 7d -c
  bob stats -f json
  bob stats -f csv

Environment:
  BOB_CONFIG_FILE  Exact Bob config file; defaults to ~/.config/bob/config.yml
  BOB_DIR          Bob vault root when --bob-dir is omitted
  BOB_NOW          Local datetime override that pins today for the report
  NO_COLOR         Disable colored output

Exit codes:
  0  report
  1  vault I/O failure
  2  usage, unknown metric, config error, or non-Dataview task format

See docs/stats.md for the catalog, JSON contract, and display rules.

bob stats show

Show one or more metrics in detail

bob stats show --help
Show one or more metrics as a detail chart (or weekday grid for booleans), with optional prior-period ticks. Pass metric ids or -a/--all for every visible metric. The command is read-only. See docs/stats.md.

Usage: bob stats show [OPTIONS] [METRIC]...

Arguments:
  [METRIC]...
          Metric id (repeatable)

Options:
  -a, --all
          Show every visible metric

  -b, --bob-dir <DIR>
          Bob vault root; defaults to BOB_DIR or ~/bob

  -c, --compare
          Include the prior period's points

  -f, --format <FORMAT>
          Output format: human, json, or csv

          [default: human]
          [possible values: human, json, csv]

  -g, --group <GROUP>
          Bucket points by auto, day, week, or month

          [default: auto]
          [possible values: auto, day, week, month]

  -h, --help
          Print help

  -o, --offset <N>
          Shift the window back this many ranges

  -r, --range <RANGE>
          Window as 7d, 4w, 3m, 1y, all, or START..END

Examples:
  bob stats show worked -c
  bob stats show worked reviewed
  bob stats show -a -f json
  bob stats show -a -f csv

Environment:
  BOB_CONFIG_FILE  Exact Bob config file; defaults to ~/.config/bob/config.yml
  BOB_DIR          Bob vault root when --bob-dir is omitted
  BOB_NOW          Local datetime override that pins today for the report
  NO_COLOR         Disable colored output

Exit codes:
  0  report
  1  vault I/O failure
  2  usage, unknown metric, config error, or non-Dataview task format

See docs/stats.md for the catalog, JSON contract, and display rules.
Tested rolling snapshot bob-cli 41afa14 bob-mac-capture 556bb67 bob-plugins af1e691 Built 2026-10-24T22:34:13Z (zensical) build.json