Reference¶
This section is for the reference of the commands, the JSON contracts and the error codes of Wayloop. There is no release yet; what comes next is in the roadmap.
Commands of a build from source¶
The wayloop binary built from crates/wayloop-cli answers the commands below. Each prints one
line of JSON on standard output. version and steps exit with code 0; the version is the one
of the workspace manifest. validate checks artifacts against their schemas and is described on
its own page, wayloop validate.
| Command | Output |
|---|---|
wayloop version (also wayloop --version) |
The name and the version of the engine |
wayloop steps |
The identifiers of the steps of the issue cycle, in order |
wayloop validate --input <file\|-> |
The envelope of the validation of a set of artifacts (wayloop validate) |
$ cargo run -q -p wayloop-cli -- version
{"name":"wayloop","version":"0.0.0"}
$ cargo run -q -p wayloop-cli -- steps
{"issue_steps":["claim","reanalysis","counter_review","checklist","build","verify","review","pull_request","merge"]}
Any other command, or no command, prints on standard output the envelope of a usage error
(code usage, described in wayloop validate), prints a usage line on
standard error, and exits with code 2:
$ cargo run -q -p wayloop-cli 2>&1 >/dev/null
wayloop: No command was given. Commands: version, steps, validate --input <file|-> [--command-version <n>].
When standard output cannot be written, for example because the reading end of a pipe is closed, the command prints the cause on standard error and exits with code 3, an environment error. The exit codes follow ADR 0009 (C7).
The step identifiers are snake_case values of the contract, as every enum value of the JSON
contracts (ADR 0009, C4), and have the same
spelling in every channel. Other spellings, such as the labels of the issue tracker, are
produced by the adapters from these values. Adding a step is an additive change; renaming or
removing a step is a breaking change of the contract. The steps themselves are described in
The loop.
JSON contracts¶
The schemas of the contracts are published with this site, each at the URL of its $id, under
https://salvo8519.github.io/wayloop/schemas/. The history of every contract, with the files
of each version and their SHA-256, is in schemas/index.json at the same address, and in
index.json in the folder of each contract.
| Contract | History, with the current version and the file of each version |
|---|---|
| Brief (wayloop validate) | schemas/artifacts/brief/index.json |
Input and result of wayloop validate (wayloop validate) |
schemas/commands/validate/index.json |
| Envelope of every command result (ADR 0009, C1) | schemas/envelope/result/index.json |
A version, once released, changes only additively: a new optional input member, a new output
member, a new enum value. Any other change is a new version, published beside the earlier
one, which never changes. Clients accept members and enum values they do not know
(ADR 0009, C5).