Skip to main content

verdictan doctor

The verdictan doctor command runs local health checks to find frequent setup and connectivity problems.

Usage​

verdictan doctor

What it checks​

CheckDescription
API reachabilityCalls the API health endpoint when an API token is available. If no token is available, it reports a warning and skips the request.
Config fileMakes sure that the selected config is available and contains correct YAML. Use verdictan policy lint for schema validation.
State directoryVerifies state directory permissions and accessibility
Supervisor stateReads local supervisor records for gateways and reports their lifecycle state. It does not test a gateway HTTP listener.

When to use it​

In these conditions, run verdictan doctor as the first diagnostic step:

  • A managed gateway fails to start or connect
  • CLI commands return unexpected connection errors
  • After you change VERDICTAN_API_URL or other environment variables
  • After a new installation to verify the setup

Output​

Doctor shows an icon and an ok, warn, or fail state for each named check. Use --json for machine-readable output. The diagnostic messages use the active profile and local state. A typical run has this format:

  ✓ api_connectivity: API reachable at https://api.verdictan.com
  ✓ config_file: valid YAML at policy-config.yaml
  ✓ state_directory: state directory writable at /home/user/.verdictan
  ! proxy_liveness: no proxy instances registered

All checks passed.

Warnings do not make the command fail. If one or more checks have fail status, the summary is Some checks failed. Review the output above.

verdictan doctor returns a nonzero exit status when one or more checks have fail status. Warnings do not change the success status. For automation, use the exit status as the gate. Use verdictan doctor --json when each check result is necessary.

Next steps​