Command-line reference

ltd

ltd is a command-line client for LSST the Docs.

Use ltd to upload new site builds, and to work with the LTD Keeper API.

ltd [OPTIONS] COMMAND [ARGS]...

Options

--log-level <log_level>

Logging level (for first-party messages). Default: info.

Options:

warning | info | debug

--host <keeper_hostname>

Hostname of the LTD Keeper API (or $LTD_HOST). Default: https://keeper.lsst.codes.

-u, --user <username>

Username for LTD Keeper (or $LTD_USERNAME).

-p, --password <password>

Password for LTD Keeper (or $LTD_PASSWORD).

--version

Show the version and exit.

Environment variables

LTD_HOST

Provide a default for --host

LTD_USERNAME

Provide a default for -u

LTD_PASSWORD

Provide a default for -p

help

Show help for any command.

ltd help [OPTIONS] [TOPIC]

Arguments

TOPIC

Optional argument

upload

Upload a new site build to LSST the Docs.

ltd upload [OPTIONS]

Options

--product <product>

Product name (deprecated, switch to project.

--project <project>

Project name.

--org <org>

Organization name.

--dir <dirname>

Directory with files to upload. Default: (current working directory).

--git-ref <git_ref>

Git ref, or space-delimited list of git refs. This versions the build and helps LTD Keeper assign the build to an edition. Alternatively, version information can be auto-discovered by setting –gh when running in a GitHub Actions environment.

--gh

Use environment variables from a GitHub Actions environment to set the –git-ref option.

--skip

Skip the upload, making the command a no-op. Useful in CI environments to disable a site upload just by setting this option or the environment variable $LTD_SKIP_UPLOAD=true.

Environment variables

LTD_SKIP_UPLOAD

Provide a default for --skip