Skip to content

bob ref

Find, list, read, rename, and plan references for today; sync Highlights PDFs into them

bob ref --help
Find, list, read, rename, and plan Bob reference notes for today, and sync Highlights PDFs into them

Usage: bob ref [OPTIONS] <COMMAND>

Library:
  find           Look up URLs, arXiv IDs, DOIs, paths, or titles in the library
  list           List notes by reading state, status, type, origin, or date
  migrate-tasks  Move open ref tasks into parent notes; dry run unless --write
  migrate-zorg   Migrate zorg-era records to ref/zorg/; dry run unless --write
  rename         Rename a reference's files and update every link to it
  show           Show notes with metadata, annotations, and your own notes
  today          Pull a reference's reading task into today's Pomodoro (sets it
                 Next)

Highlights pipeline:
  create  Create a Highlights-ready PDF from a vault note, Markdown, a PDF, or a
          URL
  doctor  Check library health and Highlights sync prerequisites
  jobs    Queue and clip reading-queue links in the background
  marker  Inspect the marker note for one PDF
  scan    Scan the configured Highlights library
  sync    Sync one PDF marker note into its Bob reference note

Options:
  -n, --no-hooks  Ignore the configured highlights.pre_scan_hook
  -h, --help      Print help

Examples:
  bob ref find https://arxiv.org/abs/1706.03762   Is this paper already in the library?
  bob ref list                                    Show the reading queue
  bob ref list -R finished -S 30d                 Show what was finished in the last 30 days
  bob ref rename <REF> <NAME> -d                  Preview renaming a reference's files
  bob ref show ea_graph -c                        Read your comments on one reference
  bob ref today <REF> -p reading                  Pull a reference into today's Pomodoro
  bob ref create <URL|PDF|MD> -L                  Capture a reference and narrate it
  bob ref scan                                    Sync Highlights PDFs into reference notes
  bob ref scan -i                                 File queued xlib/ PDFs into the library
Tested rolling snapshot bob-cli 41afa14 bob-mac-capture 556bb67 bob-plugins af1e691 Built 2026-10-24T22:34:13Z (zensical) build.json