Authentication Commands
Authentication and identity management for AGNT5 CLI
Authentication is required before you can create projects, deploy, or interact with the Control Plane. Credentials are stored in ~/.agnt5/config.yaml and read on every invocation.
agnt5 auth login
Launches the authentication flow. By default the CLI requests a short-lived session ID from the Control Plane, opens your browser to the PropelAuth login screen, and polls until an API key is issued. The generated key is persisted to ~/.agnt5/config.yaml so subsequent commands can reuse it.
Syntax
agnt5 auth login [options]Options
| Flag | Description |
|---|---|
--api-key <value> | Skip the browser flow and provide an existing API key. The CLI validates the key by fetching the current user before saving it locally. |
The CLI respects AGNT5_API_URL and other context settings when constructing the OAuth URLs, so ensure your context is correct before logging in. You can also provide AGNT5_API_KEY in the environment to bypass the login command entirely.
agnt5 auth logout
Clears any stored API keys and tokens from ~/.agnt5/config.yaml. You can re-authenticate later with agnt5 auth login.
Syntax
agnt5 auth logout agnt5 auth status
Displays whether you are authenticated, printing the email associated with the stored key along with the active environment and API base URL. If the saved key is invalid the command reports the failure and suggests agnt5 auth login.
Syntax
agnt5 auth status agnt5 whoami
Prints the email address tied to the stored credentials. This command is also available via agnt5 auth whoami and returns Not authenticated when no valid key is present.
Syntax
agnt5 whoami agnt5 version
Display CLI build metadata including version string, Go runtime, and platform. Use this command to inspect the CLI build information.
Syntax
agnt5 versionUse agnt5 version paired with agnt5 whoami to confirm both your binary and credentials before deploying.