Skip to main content
The HealOps CLI is the primary way to connect your tooling, run incident investigations, and verify integration health on your local machine or on-prem host.

​
Install the HealOps CLI

Homebrew (recommended):
curl installer:
pip (Python 3.12+):
Verify the install:

​
Run the onboarding wizard

healops onboard walks you through every configuration step in one session — LLM credentials, observability integrations, and communication channels.
The wizard configures: You can re-run healops onboard at any time to add or update credentials.

​
Configure integrations manually

​
Set up all integrations interactively

From the HealOps interactive shell:
Then inside the shell:

​
Set up a specific integration

​
Configure via environment variables

HealOps picks up credentials from environment variables automatically. Set the relevant variables before starting the CLI:
See the Integrations overview for the full list of environment variable names for each integration.

​
Integration categories

​
Verify integration health

After setup, confirm each integration is reachable:
To check one integration:
A passing output confirms HealOps can authenticate and read from that system. If a check fails, the output includes the specific error and a remediation hint.

​
Run your first investigation

Interactive shell — start HealOps with no arguments to enter the prompt shell. Type incidents in plain language or use slash commands:
Useful shell commands: One-shot investigation — pass an alert file directly without entering the shell:
HealOps fetches context from your connected systems, builds root cause hypotheses, and outputs a structured report. If Slack is configured, the report is also delivered to your configured channel.

​
Keep the CLI up to date

​
Uninstall

To remove HealOps and all locally stored configuration:
Pass --yes to skip the confirmation prompt:

​
Troubleshooting

healops: command not found Run source ~/.bashrc (or ~/.zshrc on macOS) after install, then retry. Docker is not running Start Docker Desktop, OrbStack, or Colima. HealOps uses containers for some integration health checks. make is missing Install via your package manager: brew install make on macOS or choco install make on Windows. No LLM provider configured Run healops onboard and follow the LLM setup step. You need a valid API key from Anthropic, OpenAI, or a compatible provider. Integration verification fails Re-run healops integrations setup <integration> to refresh credentials. Check the provider-specific page under Integrations for required API scopes.