Help › Keys, CLI and automation

Check your setup with rl doctor

Partly builtLast updated

On this page

rl doctor checks that your command-line setup is sound. It only reads. It is safe to run in CI.

What it checks#

Options#

--site to choose a site, --base and --public-key for the delivery check, --offline to make no request, and --json for machine-readable output.

Result#

It succeeds unless a check fails. A failing request returns the tool's code: 3 for sign-in, 5 for a plan problem, 6 for service unavailable. Other failures return 1.

Safety#

The output never contains your key.

See The command-line tool and CI run failed. The command is in the repository and not published: OPEN.