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

1 min read

pyssg.cli.commands.clean

pyssg clean -- remove the output directory and the build cache.

run_clean(site: Path, *, yes: bool) -> int

Remove output_dir and the cache under site; return an exit code.

Lists what will be removed and asks for confirmation unless yes is set. Returns 1 if the user declines, 0 otherwise (including when there is nothing to remove).

clean(ctx: typer.Context, yes: Annotated[bool, typer.Option('--yes', help='skip confirmation')] = False) -> None

Remove output_dir + cache.