docbuild CLI#

docbuild#

Main CLI tool for document operations.

docbuild [OPTIONS] COMMAND [ARGS]...

Options

--version#

Show the version and exit.

-v, --verbose#

Increase verbosity

--dry-run#

Run without making changes

--debug, --no-debug#

Enable debug mode. This will show more information about the process and the config files. If available, read the environment variable ‘DOCBUILD_DEBUG’.

--app-config <APP_CONFIG_FILE>#

Filename to the application TOML config file. Overrides auto-search.

--env-config <ENV_CONFIG_FILE>#

Filename to a environment’s TOML config file. If not set, docbuild uses the default filename ‘env.production.toml’ in the current working directory.

Environment variables

DOCBUILD_DEBUG

Provide a default for --debug

build#

CLI interface to build a document.

A document (or “doctype”) consists of [PRODUCT]/[DOCSET][@LIFECYCLES]/LANGS with the following properties:

* (Optional) PRODUCT is the product. To mark “ALL” products, omit the
product or use “*”
* (Optional) DOCSET is the docset, usually the version or release of
a product.
To mark “ALL” docsets, omit the docset or use “*”.
* (Optional) LIFECYCLES marks a list of lifecycles separated by comma
or pipe symbol.
A lifecycle can be one of the values ‘supported’, ‘unsupported’, ‘beta’,
or ‘hidden’.
* LANGS marks a list of languages separated by comma. Every single
language contains a LANGUAGE-COUNTRY syntax, for example ‘en-us’, ‘de-de’ etc.

Examples of the doctypes syntax:

* “//en-us”
Builds all supported deliverables for English
* “sles/*/en-us”
Builds only SLES deliverables which are supported and in English
* “sles/*@unsupported/en-us,de-de”
Builds all English and German SLES releases which are unsupported
* “sles/@beta|supported/de-de”
Build all docsets that are supported and beta for German SLES.
* “sles/@beta,supported/de-de”
Same as the previous one, but with comma as the separator between
the lifecycle states.
docbuild build [OPTIONS] [DOCTYPES]...

Arguments

DOCTYPES#

Optional argument(s)

c14n#

CLI interface to apply canonicals.

docbuild c14n [OPTIONS]

config#

CLI interface to shows config files how docbuild sees it.

docbuild config [OPTIONS] COMMAND [ARGS]...

app#

CLI interface to show the configuration of the application files.

docbuild config app [OPTIONS]

env#

CLI interface to showsthe configuration of the environment files.

docbuild config env [OPTIONS]

repo#

Manage repositories.

docbuild repo [OPTIONS] COMMAND [ARGS]...

clone#

Clone repositories.

Pass any of the following URLs to clone:

* HTTPS URLs like https://github.com/org/repo.git
* SSH URLS like git@github.com:org/repo.git
* Abbreviated URLs like ‘org/repo’
docbuild repo clone [OPTIONS] [REPOS]...

Arguments

REPOS#

Optional argument(s)

dir#

Show the directory path for permanent repositories.

docbuild repo dir [OPTIONS]

list#

List the available permanent repositories.

docbuild repo list [OPTIONS]

validate#

CLI interface to validate XML configuration files.

docbuild validate [OPTIONS] [XMLFILES]...

Arguments

XMLFILES#

Optional argument(s)