Skip to content

kindgi auth

View as Markdown

Synopsis

Terminal window
kindgi auth <command>
Signature

Manage local auth: the API's URL and token, and the runtime image's registry.

Commands

Command Description
kindgi auth login Persist an API URL + token to ~/.kindgi/config.json.
kindgi auth whoami Verify the configured token by hitting the API.
kindgi auth registry Log Docker in to the runtime image's registry (on registry.kindgi.com, with your license key), then check it can pull the image kindgi dev runs.

See also

Synopsis

Terminal window
kindgi auth login [--url=<url>] [--token=<token>]
Signature

Persist an API URL + token to ~/.kindgi/config.json.

Options

Every command also takes the global flags.

Examples

Save the API URL, and the API token exported as KINDGI_API_TOKEN, to ~/.kindgi/config.json.

Terminal window
kindgi auth login --url=https://kindgi.acme.example

From Deploy your agent to Kindgi Cloud:

Terminal window
pnpm exec kindgi auth login --url=https://platform.kindgi.com

See also

Synopsis

Terminal window
kindgi auth whoami
Signature

Verify the configured token by hitting the API.

Options

Every command also takes the global flags.

Examples

Check that the saved token works against the API.

Terminal window
kindgi auth whoami

From Deploy your agent to Kindgi Cloud:

Terminal window
pnpm exec kindgi auth whoami

See also

Synopsis

Terminal window
kindgi auth registry [--key-from <store> | --password-stdin] [--username <name>] [--check] [--registry <host>]
Signature

Log Docker in to the runtime image's registry (on registry.kindgi.com, with your license key), then check it can pull the image kindgi dev runs.

Options

Option Default Description
--check off Only check that Docker can pull the image, without logging in.
--key-from <value> none Read the license key from where it's kept, as kindgi license renew does: file:…, env-file:…#NAME, gcp:…, azure:…, aws:…. For registry.kindgi.com only.
--password-stdin off Read the license key (on another registry, the token) from stdin instead of prompting for it.
--registry <value> registry.kindgi.com, the runtime image's registry The registry to log in to, such as a mirror; the check then looks for the image there. Default: the runtime image's registry (registry.kindgi.com).
--username <value> kindgi on registry.kindgi.com; required on another registry (except with --check) Your username on another registry, which goes with that registry's own token. Not needed on registry.kindgi.com, which takes your license key.

Every command also takes the global flags.

Examples

Log Docker in to registry.kindgi.com with your license key, then check the pull; the key is prompted for.

Terminal window
kindgi auth registry

Log in in a script, reading the license key from stdin.

Terminal window
kindgi auth registry --password-stdin < kindgi-license-key.txt

Log in to registry.kindgi.com with the license key a deployment already keeps, so it never passes through your shell.

Terminal window
kindgi auth registry --key-from env-file:kindgi.env#KINDGI_LICENSE_KEY

Check that Docker can already pull the image, without logging in.

Terminal window
kindgi auth registry --check

Log in to a mirror of the image instead, with that registry's own username and token; the check then looks for the image there.

Terminal window
kindgi auth registry --registry=registry.acme.example --username=acme-ci --password-stdin < mirror-token.txt

From Install:

Terminal window
npx --yes @kindgi/cli@0.2 auth registry

See also