Module codes 

Every diagnostic and error code DRE reports, in one registry.

A code is a readable slug (unknown-key) that begins every diagnostic and names a section of the error codes reference. dre explain <code> prints its explanation, and --log-format json events, dre validate --json and run_results.json carry it. Each code has a Kind, which decides the exit code and whether a failure is worth retrying. A plugin’s codes are namespaced by the plugin (sftp/host-key-mismatch) and declared in its descriptor.

From 1.0 codes are stable: a code is never reused, only retired, and renaming one is a breaking change.

Enums

Code

A registered code. See the module docs.

ErrorCode

A code as a failure reports it: a registered Code, or a plugin’s own, namespaced by the plugin (sftp/host-key-mismatch) with the kind the plugin gave.

Kind

What kind of problem a code is.

Constants

REFERENCE_URL

Where the error codes reference is published; a code’s section is #<slug>.

Functions

reference_page

The error codes reference, docs/reference-error-codes.md: every code by kind, with its summary and explanation. Generated; a test fails when the committed page is stale.