Commands

Build, check and test a repository, and generate what its schemas and commands declare

Every command answers in a commandEnvelope.

CommandDescription
dev installPoint the application's installed executable at a checkout
dev 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
dev syncSynchronize workspace configuration with manifest
dev buildBuild project modules and artifacts
dev compileCompile each application into the executable a client is handed
dev testRun the repository's tests, whole or as selected by module, path, tier or change
dev lintRun code linters to check for issues
dev typecheckValidate type schemas for correctness and consistency
dev formatAuto-format code according to project style
dev gateRun the verification gate's checks and report each one's outcome and duration
dev vendorObtain this repository's declared library dependencies and its repo adapter from the catalogs it reads

Groups

GroupDescription
dev configManage the application's configuration files
dev engineShow the runtime engine the application runs on, or move it to another
dev versionShow the application's version and the versions a release store holds
dev moduleInspect and manage project module structure and dependencies
dev packageWhat each module publishes when the repository is built
dev executableThe executables a repository's applications are built as
dev projectReport, and with --validate refuse, what a project states about itself and the repositories it pins, and mark its version
dev todoReport the annotation comments a repository's source carries
dev gitignoreGenerate the ignore file a repository of this framework carries

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