Commands

Install applications and vendor libraries from the catalog they are released to

Every command answers in a commandEnvelope.

CommandDescription
toolchain installInstall an application for this user from the catalog -- its newest release, or the one named with @<version> -- built for this machine's platform, checked against the digest the catalog records, and started by a launcher in the one directory already on PATH; the version already installed is left as it is, and another is refused in favour of update or --force
toolchain updateMove this application to its newest release, or to the one --to names -- for an application the toolchain installed, which fetches the public release built for this machine, checks it and puts it in place, showing the download and then what the release changed; a release older than the one installed is refused without --force; refused for an application run from its source or started from outside the install directory
toolchain vendorPlace a library from the catalog in the directory this is run in, where the library itself says it goes, with what it depends on beside it -- its newest release, or the one named with @<version>, checked against the digest the catalog records; the directory needs no manifest and no configuration, and what an earlier run placed is taken back first

Groups

GroupDescription
toolchain configManage the application's configuration files
toolchain engineShow the runtime engine the application runs on, or move it to another
toolchain versionShow the application's version and the versions a release store holds
toolchain tokenSet, clear and show the distribution token the product's stores are read with

Global arguments

Every command takes these as well as its own.

ArgumentTypeRequiredDefaultDescription
--manifestpathNoManifest file path
--app-configpathNoOverride the app config file to load for this invocation
--verbose,
--no-verbose
booleanNofalseAdd detail to a command's human-readable output, such as all-clear lines and entries a report otherwise leaves out; it does not change the log level, which is --log-level
--log-module-paths,
--no-log-module-paths
booleanNofalseTag log entries with the Python module that wrote them instead of the repository's project name
--log-levelenum one of debug, verbose, info, warn, errorNoLowest severity shown on the console, from the run's first line; the log file records every entry regardless. Outranks LOGGER_LEVEL when both are given. verbose shows each run's start and outcome (default: LOGGER_LEVEL, else the application's own)
--response-formatenum one of plain-text, jsonNo"plain-text"Response output format (default: plain-text)
--pretty,
--no-pretty
booleanNofalseWhen used with --response-format json, pretty-print JSON output
--complex-input-formatenum one of json, ymlNo"json"Input format for complex command arguments (default: json)
--complex-input-source-typeenum one of serialized, filepathNo"serialized"Source type for complex command arguments: serialized (inline) or filepath (default: serialized)
--repo-rootpathNoRepository root path (default: the current directory, searched upward for a manifest)
--runtime-configpathNoOverride the runtime config file to load for this invocation
--from-stdin,
--no-from-stdin
booleanNofalseTake this command's inputs, by name, from the envelope piped to stdin by a command run with --response-format json; a flag given beside it still wins, and a field the command declares no input for is refused. A document input given - takes the piped answer as that one input instead, and one given =-:<path> the field at that path, as =-:releases[0].notes
--version,
--no-version
booleanNofalsePrint the version of the application, or of the command it follows, and exit