Command reference

Each page documents a group of commands. Each command entry includes the synopsis, arguments, flags, output, and exit codes. The introduction explains the objects the commands act on.

Conventions

• A synopsis uses square brackets for an optional part and angle brackets for a value to supply. A vertical bar separates alternatives.
• A command that calls district-api accepts --production, --staging, or --dev. Without one, the command uses the environment that the last district login recorded, or production.
• A command that acts on a repository reads the clone in the current directory when no argument names one. The clone's origin names the repository and the environment.
• A command that waits on the network shows an indicator on stderr while it waits, when stderr is a terminal. On a terminal, the identifiers a person reads back are bold and each status has a symbol and a color. A pipe, a CI log, NO_COLOR, and --json get plain bytes: no indicator, no color, and no symbols.
• build, deploy, app delete, repo delete, target delete, and domain remove ask a [y/N] question first. --yes answers it. A session with no terminal cannot answer, so it needs the flag. addon delete asks no question and requires --confirm instead, because it destroys data. Every other command acts without a question.
• Exit code 0 means the command completed its documented result. Exit code 1 means the command ran and the result is a failure, or the API refused the call with its own message. Exit code 2 means the command line names nothing the command can run. The custom-domain commands also exit 3 when the certificate provider does not answer, and the addon commands exit 3 when the addon service does not answer.