pyssg is pre-1.0 and under active development - APIs, config, and themes may change.
pyssg.cli.commands.build

1 min read

pyssg.cli.commands.build

pyssg build -- full build to the output directory.

run_build(site: Path, *, no_cache: bool, profile: bool, json_output: bool) -> int

Run one full build; return a process exit code.

With json_output a single JSON object is printed to stdout -- {"ok": true, ...} on success or {"ok": false, "error": ...} on failure -- and the build exception is swallowed into that object (the stable contract the Obsidian adapter parses). Otherwise a human-readable summary is printed and a build error propagates.

build(ctx: typer.Context, no_cache: Annotated[bool, typer.Option('--no-cache', help='ignore the persistent cache')] = False, profile: Annotated[bool, typer.Option('--profile', help='print per-phase counts')] = False, json_output: Annotated[bool, typer.Option('--json', help='emit a machine-readable summary')] = False) -> None

Full build to output_dir.