Files
paperspec/docs/package/reference/cli.md
T
alexmandClaude 30d310f64d Publish the package and its documentation, and move to the papers organization
Add the Zensical documentation of the Python package (docs/package, built by the docs
workflow), merge the standard publish workflow with the setuptools-scm tag check, add the
SPDX header rule to ruff, restructure the README, and point every repository and registry
address at the Gitea organization papers.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01B8cL4zN4XpaQF5cBtASzfq
2026-10-19 04:23:49 -04:00

3.5 KiB

Command line

One command, paperspec, with six subcommands. python -m paperspec runs the same program. paperspec --version prints the package version and the Unicode version it pins, and paperspec COMMAND --help prints a command's options, advice and examples.

Command Works Does
validate anywhere the package is installed with its tools extra Validate packages, or run proposed corrections through the gate.
load anywhere the package is installed with its tools extra Validate packages and load them into a SQLite database.
check in a checkout Check the whole repository.
build in a checkout Rebuild fixtures/ and vectors/ from their sources.
stress in a checkout Stress the oracle with random inputs.
site in a checkout Build the website into _site/.

A misspelled command gets a suggestion, and an option a command does not know is refused. "In a checkout" means the repository an editable install points at, or else the one around the current folder.

validate

paperspec validate [-h] [--correction PROPOSALS] [--max-size BYTES] PACKAGE [PACKAGE ...]
Option Meaning
PACKAGE A package folder or a zipped package (.sct.zip), unpacked under the specification's path rules first.
--correction PROPOSALS A JSON file holding one proposed correction, or a JSON Lines file of several, run through the gate against the one package given. Each record that would be appended to corrections.jsonl is printed, until one is refused. Nothing is written.
--max-size BYTES Refuse a zipped package that expands past this many bytes (default 1073741824).

Each failure is printed to standard error as package: where: rule: message. Exit status: 0 when everything is valid, 1 when something is refused, 2 for a usage error.

load

paperspec load [-h] --sqlite DATABASE [--bundle] [--built-from REV] [--store STORE] [--max-size BYTES] PACKAGE [PACKAGE ...]
Option Meaning
PACKAGE A package folder or a zipped package. Every package is validated first, and nothing is loaded if any fails.
--sqlite DATABASE The database file, created with the tables of sql/ if it does not exist. Files with no table of their own are copied into DATABASE.assets/.
--bundle Build a new scienting-bundle/1 file with the full-text search index. Needs --built-from.
--built-from REV With --bundle: the store revision the packages come from.
--store STORE With --bundle: the store's name (default: the packages' common store).
--max-size BYTES As for validate.

check

paperspec check [-h] [--quick]

--quick skips the byte-for-byte rebuild. Exit status: 0 when every check passed, 1 otherwise.

build

paperspec build [-h] [--out DIR]

Without --out it rewrites fixtures/ and vectors/ in the checkout; with it, it builds into DIR instead.

stress

paperspec stress [-h] [--seed SEED] [--rounds ROUNDS]

--seed sets the random seed (default 20261014) and --rounds the cases per property (default 200). Exit status: 0 when every property held, 1 otherwise.

site

paperspec site [-h] [--out DIR] [--base-url URL]

--out sets the output folder, which must not be the repository or contain it (default _site/ in the checkout). --base-url sets the site's address for canonical links (default https://paperspec.scient.ing).