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#
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 <operation>: one functionality, such asjeden.invocation(reading the command line) orjeden.errors(this command), with every cause:failed,cause,observed,fixandtest, and its code and exit status.--json:listanswers{"operations": [...]};showanswers one catalogue:operation,entries,uses,summary,docsandcauses, each cause withid,code,exit,retryable,usage,failed,cause,observed,remedy,testanddoc.- Jeden Desktop and any RPC client read the same JSON through
jeden rpc:errors/listtakes no parameters anderrors/showtakes{"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: <operation>.<cause>; `jeden errors show <operation>` 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
listandshow:reading the verb `<verb>` of `jeden errors`: `jeden errors` answers list and show, and `<verb>` is neither; observed: the request: jeden errors <words>, fix: runjeden errors listorjeden errors show <operation>; exit 2. showwithout an id (RPCerrors/showwithoutoperation):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: <ids>; exit 2, RPCinvalid_params.- A word after
listor after the id ofshow(an RPC parameter other thanoperation):reading `<verb>`: <verb> takes <what it takes>, and `<word>` follows it, fix: drop it; exit 2, RPCinvalid_params. - An id no functionality declares:
finding the functionality `<id>`: no functionality <id> declares how it fails; observed: the functionalities that do: <ids>; exit 1, RPCnot_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) exits69; any other refusal or failure exits1. A refusal a functionality declares ends withfix: …andcause: <operation>.<cause>, andjeden errors show <operation>lists every cause of that functionality.