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, 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 [--username <name>] [--password-stdin] [--check] [--registry <host>]
Signature

Log Docker in to the runtime image's registry, 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.
--password-stdin off Read the token from stdin instead of prompting for it.
--registry <value> quay.io, 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 (quay.io).
--username <value> required (except with --check) Your pull credential's robot name, shown at https://access.kindgi.com once you sign in with GitHub. Needed to log in.

Every command also takes the global flags.

Examples

Log Docker in to the runtime image's registry with the robot name you were given, then check the pull; the token is prompted for.

Terminal window
kindgi auth registry --username=acme+reader

Log in in a script, reading the token from stdin.

Terminal window
kindgi auth registry --username=acme+reader --password-stdin < registry-token.txt

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

Terminal window
kindgi auth registry --check

From Install:

Terminal window
npx --yes @kindgi/cli@0.1 auth registry --username <your robot name>

See also