Help › Keys, CLI and automation
Check your setup with rl doctor
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#
- Your Node version.
- That your
.resilientlang.jsonfile holds no key. - That the credentials file can be read only by you.
- That your key looks like a secret key (
rl_sec_) and not a public site key. - That the control-plane address is a secure one, and that a site is chosen.
- One real request with your key. A 401, 403, 402 or 503 answer is explained.
- The scopes of your key, when it may list keys.
- Your plan allowance.
- With delivery settings: the published manifest and its signature.
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.