Commands
Build, check and test a repository, and generate what its schemas and commands declare
Every command answers in a commandEnvelope.
| Command | Description |
|---|---|
dev engine | Show or update the CLI runtime engine version |
dev install | Point the application's installed executable at a checkout |
dev update | Move this application to its newest release -- for an application the toolchain installed, which fetches the newest public release built for this machine, checks it and puts it in place, showing the download and then what the release changed; refused for an application run from its source or started from outside the install directory |
dev sync | Synchronize workspace configuration with manifest |
dev build | Build project modules and artifacts |
dev test | Run the repository's tests, whole or as selected by module, path, tier or change |
dev lint | Run code linters to check for issues |
dev format | Auto-format code according to project style |
dev gate | Run the verification gate's checks and report each one's outcome and duration |
dev selection | Report what a run of test, lint or type check would cover in each repository, without running it |
dev vendor | Obtain this repository's declared library dependencies and its repo adapter from the catalogs it reads |
dev todos | Find TODO/LATER comments in configured scan roots |
Groups
| Group | Description |
|---|---|
dev config | Manage the application's configuration files |
dev version | Show the application's version and the versions a release store holds |
dev module | Inspect and manage project module structure and dependencies |
dev project | Report, and with --check refuse, what a project states about itself and the repositories it pins |
dev type | Validate schema documents |
dev gitignore | Generate the ignore file a repository of this framework carries |
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 | |
--version, --no-version | boolean | No | false | Print the version of the application, or of the command it follows, and exit |