Skip to content
GitLab

akili status

Check the health status of the Akili platform. This command performs three diagnostic checks against the control plane API and reports the results.

Terminal window
akili status

akili status is a combined health check that verifies:

  1. API Health — Whether the control plane API is reachable (/healthz endpoint)
  2. API Readiness — Whether the API is ready to serve traffic (/readyz endpoint)
  3. Authentication — Whether the configured token is valid and identifies the authenticated user

No subcommands or arguments are required. The command checks all three dimensions and reports each with an OK, WARN, or FAIL indicator.

Akili Platform Status
OK API Health: alive
OK API Ready: ready
OK Auth: authenticated (developer@example.com)

Each check reports one of three states:

StateMeaning
OKCheck passed successfully
WARNPartial issue (e.g., no token configured, API returning non-200)
FAILCheck failed (e.g., API unreachable, authentication rejected)
Terminal window
# Quick health check
akili status
# Health check against a specific environment
akili status --api-url https://api.staging.akili.io
# Health check with a specific profile
akili status --profile production

CI/CD pre-flight check: Run akili status at the start of a deployment pipeline to verify the platform is reachable and credentials are valid before attempting any operations.

#!/bin/bash
akili status || { echo "Platform unavailable"; exit 1; }
akili product deploy daily-orders --version v2.1.0

Debugging connectivity: When other commands fail with connection errors, akili status isolates whether the issue is network connectivity, API health, or authentication.

CodeMeaning
0All checks passed
1One or more checks failed
FlagShortDefaultDescription
--jsonfalseOutput as JSON instead of tables
--no-colorfalseDisable colored output
--profiledefaultConfig profile to use
--api-urlfrom configAPI base URL override
--timeout30Request timeout in seconds