Command line

The imprenta command is a thin layer over imprenta.Project. A spec is <catalog>, <product> or <catalog>/<product>, each optionally .<variant>. This page is the parser's own help, rendered at build time.

usage: imprenta [-h]
                {new,build,check,status,affected,doctor,manager,version} ...

Arrange content into products and render them.

positional arguments:
  {new,build,check,status,affected,doctor,manager,version}
    new                 write the starter project into a new folder
    build               build targets: specs, or everything the catalogs
                        subscribe
    check               validate content and catalogs
    status              list every product of every catalog
    affected            list the targets a change set since a commit affects
    doctor              check that every external tool is installed
    manager             the TUI (needs imprenta[tui])
    version             print the version

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

imprenta new

usage: imprenta new [-h] [--name NAME] [--pin PIN] dir

positional arguments:
  dir          the folder to create (or an empty one)

options:
  -h, --help   show this help message and exit
  --name NAME  the project name (default: the folder's name)
  --pin PIN    the imprenta release to pin (default: this engine's)

imprenta build

usage: imprenta build [-h] [--tag TAG] [--force] [--jobs JOBS] [--html]
                      [--preview]
                      [spec ...]

positional arguments:
  spec         <catalog> | <product> | <catalog>/<product>, each optionally
               .<variant>

options:
  -h, --help   show this help message and exit
  --tag TAG    only products carrying this tag
  --force      rebuild even if up to date
  --jobs JOBS
  --html       stop after HTML (one pdf target)
  --preview    HTML with the Paged.js polyfill for a live browser preview

imprenta check

usage: imprenta check [-h]

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

imprenta status

usage: imprenta status [-h]

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

imprenta affected

usage: imprenta affected [-h] [--since SINCE] [--all] [--tag TAG]
                         [--variant VARIANT] [--bundle BUNDLE]

options:
  -h, --help         show this help message and exit
  --since SINCE      the commit to diff against (omit = everything)
  --all              ignore --since: everything
  --tag TAG          only products carrying this tag
  --variant VARIANT  limit to one variant
  --bundle BUNDLE    limit to one bundle's variants

imprenta doctor

usage: imprenta doctor [-h]

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

imprenta manager

usage: imprenta manager [-h]

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

imprenta version

usage: imprenta version [-h]

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