Commands
Install applications and vendor libraries from the catalog they are released to
Every command answers in a commandEnvelope.
| Command | Description |
|---|---|
toolchain install | Install 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 update | Move 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 vendor | Place 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
| Group | Description |
|---|---|
toolchain config | Manage the application's configuration files |
toolchain engine | Show the runtime engine the application runs on, or move it to another |
toolchain version | Show the application's version and the versions a release store holds |
toolchain token | Set, clear and show the distribution token the product's stores are read with |
Global arguments
Every command takes these as well as its own.
| Argument | Type | Required | Default | Description |
|---|---|---|---|---|
--manifest | path | No | Manifest file path | |
--app-config | path | No | Override the app config file to load for this invocation | |
--verbose,--no-verbose | boolean | No | false | Add 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 | boolean | No | false | Tag log entries with the Python module that wrote them instead of the repository's project name |
--log-level | enum one of debug, verbose, info, warn, error | No | Lowest 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-format | enum one of plain-text, json | No | "plain-text" | Response output format (default: plain-text) |
--pretty,--no-pretty | boolean | No | false | When used with --response-format json, pretty-print JSON output |
--complex-input-format | enum one of json, yml | No | "json" | Input format for complex command arguments (default: json) |
--complex-input-source-type | enum one of serialized, filepath | No | "serialized" | Source type for complex command arguments: serialized (inline) or filepath (default: serialized) |
--repo-root | path | No | Repository root path (default: the current directory, searched upward for a manifest) | |
--runtime-config | path | No | Override the runtime config file to load for this invocation | |
--from-stdin,--no-from-stdin | boolean | No | false | Take 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 | boolean | No | false | Print the version of the application, or of the command it follows, and exit |