Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.devhelm.io/llms.txt

Use this file to discover all available pages before exploring further.

The DevHelm CLI is distributed as an npm package. Install it globally to manage monitors, deploy configs, and interact with the API from your terminal.

Requirements

  • Node.js 18 or later
  • npm (included with Node.js)

Install

npm install -g devhelm
Verify the installation:
devhelm --version

Pin a specific version

For reproducible CI builds, install an exact version (latest stable: 1.0.0):
npm install -g devhelm@1.0.0

Update

npm install -g devhelm@latest
To check which version you’re running:
devhelm version

GitHub Actions

Use the official setup-devhelm action to install and configure the CLI in CI:
- uses: devhelmhq/setup-devhelm@v1
  with:
    api-token: ${{ secrets.DEVHELM_API_TOKEN }}
The action handles Node.js setup, npm caching, and environment variable configuration. See GitHub Actions integration for the full reference.

Uninstall

npm uninstall -g devhelm
To also remove saved credentials:
rm -rf ~/.devhelm

Next steps

Authentication

Set up API tokens and saved contexts.

CLI Quickstart

Create your first monitor from the terminal.