spacr.cli_workspace

Inspect the workspace saved with a run without launching the GUI.

A run can contain workspace.json beside its manifest. The document records the databases and panels that were open, their view state, and the files they reference. spacr-workspace prints that information from a terminal.

Usage:

spacr-workspace ~/.spacr/runs/2026-08-19_143507_ab12cd34__regression
spacr-workspace <run-folder> --files          # only the file inventory
spacr-workspace <run-folder> --json           # the document itself

This is useful for checking which database a shared run used and whether the referenced files still match, including on machines without a display.

Exit codes:

0 — a workspace was found and printed 2 — the folder does not exist, or carries no workspace

Functions

main(→ int)

Print a saved workspace and return a process exit code.

Module Contents

spacr.cli_workspace.main(argv=None) → int

Print a saved workspace and return a process exit code.

Parameters:

argv – command-line arguments without the program name. None reads sys.argv.

Returns:

0 when a workspace was printed, or 2 when the requested path or workspace document does not exist.

Raises:

SystemExit – with status 2 when command-line arguments are invalid.