Command line

tensorboard-book [ROOT] [--host 127.0.0.1] [--port 8501] [--depth 1]
                 [--db PATH] [--workers N] [--no-auth] [--no-browser]
                 [--tensorboard-host 127.0.0.1]          scan, then start the app
tensorboard-book view --logdir RUN [RUN ...] [TB args]   TensorBoard on some runs
tensorboard-book scan ROOT [--depth N] [--force]         index without the app (cron)
tensorboard-book hash-password                           create the password hash
tensorboard-book demo [DEST]                             create demo runs
tensorboard-book export-annotations ROOT [-o FILE]       write annotations to JSON
tensorboard-book import-annotations ROOT FILE            merge annotations from JSON
tensorboard-book -v, --version                           print the version

Streamlit prints the address to open. Usage statistics are off, and the app doesn't watch its source files for changes.

Starting the app first scans the folder in the terminal, using up to four processes (--workers), so the page opens with everything indexed. Rescans from the app (the Rescan button and Auto) run inside the app in a single process and only re-read runs that changed. As a rough guide, 300 runs with 6.6 million scalar values (290 MB) take about 35 s with one worker and 18 s with four. An unchanged folder rescans in under a second.

Options of each command

The output of --help for each command, as installed.

tensorboard-book

-v or --version prints the version and the years of the project, for example:

$ tensorboard-book --version
tensorboard-book version 0.9.0 2026

usage: tensorboard-book [-h] [-v]
                        {serve,scan,view,hash-password,demo,export-annotations,import-annotations}
                        ...

Bookkeeping for folders of TensorBoard runs.

positional arguments:
  {serve,scan,view,hash-password,demo,export-annotations,import-annotations}
    serve               start the web app (default)
    scan                index a folder without starting the app
    view                show only some runs in TensorBoard (tensorboard-view)
    hash-password       create the password hash variable
    demo                create a folder of fake runs
    export-annotations  write annotations to JSON
    import-annotations  merge annotations from JSON

options:
  -h, --help            show this help message and exit
  -v, --version         show program's version number and exit

tensorboard-book serve

The default command: tensorboard-book ROOT is the same as tensorboard-book serve ROOT.

usage: tensorboard-book serve [-h] [--depth DEPTH] [--db DB]
                              [--workers WORKERS] [--host HOST] [--port PORT]
                              [--no-auth] [--no-browser]
                              [--tensorboard-host TENSORBOARD_HOST]
                              [root]

positional arguments:
  root                  runs folder

options:
  -h, --help            show this help message and exit
  --depth DEPTH         folder depth of runs
  --db DB               database path (default: ROOT/.tensorboard-
                        book/index.db)
  --workers WORKERS     processes used to parse runs (default: up to 4)
  --host HOST           address to listen on
  --port PORT           port to listen on (default: 8501, or the next free
                        one)
  --no-auth             skip the password even if TBOOK_PASSWORD_HASH is set
                        (only with a local --host)
  --no-browser          don't open the app in a browser tab
  --tensorboard-host TENSORBOARD_HOST
                        address for TensorBoards opened from the app (they
                        have no password, so keep it local unless your
                        network is trusted)

tensorboard-book view

usage: tensorboard-book view [-h] --logdir LOGDIR [LOGDIR ...]

Show only some runs in TensorBoard. Other options are passed on to
TensorBoard.

options:
  -h, --help            show this help message and exit
  --logdir LOGDIR [LOGDIR ...]
                        run folders to show

tensorboard-book scan

usage: tensorboard-book scan [-h] [--depth DEPTH] [--db DB]
                             [--workers WORKERS] [--force]
                             [root]

positional arguments:
  root               runs folder

options:
  -h, --help         show this help message and exit
  --depth DEPTH      folder depth of runs
  --db DB            database path (default: ROOT/.tensorboard-book/index.db)
  --workers WORKERS  processes used to parse runs (default: up to 4)
  --force            re-parse every run

tensorboard-book hash-password

usage: tensorboard-book hash-password [-h]

options:
  -h, --help  show this help message and exit

tensorboard-book demo

usage: tensorboard-book demo [-h] [dest]

positional arguments:
  dest

options:
  -h, --help  show this help message and exit

tensorboard-book export-annotations

usage: tensorboard-book export-annotations [-h] [--depth DEPTH] [--db DB]
                                           [--workers WORKERS] [-o OUTPUT]
                                           [root]

positional arguments:
  root                  runs folder

options:
  -h, --help            show this help message and exit
  --depth DEPTH         folder depth of runs
  --db DB               database path (default: ROOT/.tensorboard-
                        book/index.db)
  --workers WORKERS     processes used to parse runs (default: up to 4)
  -o OUTPUT, --output OUTPUT

tensorboard-book import-annotations

usage: tensorboard-book import-annotations [-h] [--depth DEPTH] [--db DB]
                                           [--workers WORKERS]
                                           root file

positional arguments:
  root
  file

options:
  -h, --help         show this help message and exit
  --depth DEPTH      folder depth of runs
  --db DB            database path (default: ROOT/.tensorboard-book/index.db)
  --workers WORKERS  processes used to parse runs (default: up to 4)