Jeden/Docs

CLI command

jeden errors

Print every way each Jeden functionality can fail: what failed, why, the state the refusal shows, what fixes it, its code, its exit status and the test that provokes it.

Exact invocation#

Shell
jeden errors [list|show <operation>] [--json]

Inputs and options#

  • No verb, or list: every functionality that declares how it fails, one line each with its id, its number of causes, the commands and RPC methods that start it, and its documentation page.
  • show &lt;operation&gt;: one functionality, such as jeden.invocation (reading the command line) or jeden.errors (this command), with every cause: failed, cause, observed, fix and test, and its code and exit status.
  • --json: list answers {"operations": [...]}; show answers one catalogue: operation, entries, uses, summary, docs and causes, each cause with id, code, exit, retryable, usage, failed, cause, observed, remedy, test and doc.
  • Jeden Desktop and any RPC client read the same JSON through jeden rpc: errors/list takes no parameters and errors/show takes {"operation": ID}.

Output and state effect#

Reads the catalogues compiled into this binary and prints them; it reads no workspace, environment file or configuration, so a configuration Jeden cannot read does not hide how Jeden fails. Every declared refusal Jeden prints ends with fix: … and cause: &lt;operation&gt;.&lt;cause&gt;; `jeden errors show &lt;operation&gt;` lists every cause of it, so the line that names a refusal is the way to its whole catalogue. Over jeden rpc the error of a refusal Jeden declared carries the same by field beside code and message: data: {"functionality", "cause", "remedy", "retryable"}, the remedy being the fix: line with its values filled in; a refusal no catalogue declares yet has no data.

Refusals and boundaries#

  • A verb other than list and show: reading the verb `&lt;verb&gt;` of `jeden errors`: `jeden errors` answers list and show, and `&lt;verb&gt;` is neither; observed: the request: jeden errors &lt;words&gt;, fix: run jeden errors list or jeden errors show &lt;operation&gt;; exit 2.
  • show without an id (RPC errors/show without operation): reading which functionality `jeden errors show` describes: jeden errors show requires the id of a functionality, and the request names none; observed: the request: …; the functionalities that declare how they fail: &lt;ids&gt;; exit 2, RPC invalid_params.
  • A word after list or after the id of show (an RPC parameter other than operation): reading `&lt;verb&gt;`: &lt;verb&gt; takes &lt;what it takes&gt;, and `&lt;word&gt;` follows it, fix: drop it; exit 2, RPC invalid_params.
  • An id no functionality declares: finding the functionality `&lt;id&gt;`: no functionality &lt;id&gt; declares how it fails; observed: the functionalities that do: &lt;ids&gt;; exit 1, RPC not_found.
  • A command line of the wrong form (an unknown command or option, a missing, unexpected or invalid argument, a missing confirmation) prints the error and the usage and exits 2; a refusal that retrying unchanged can help (a dependency down or not answering, a rate limit) exits 69; any other refusal or failure exits 1. A refusal a functionality declares ends with fix: … and cause: &lt;operation&gt;.&lt;cause&gt;, and jeden errors show &lt;operation&gt; lists every cause of that functionality.