> ## Documentation Index
> Fetch the complete documentation index at: https://pulse-41cf5b0d.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# pulse CLI — Official PulseGuard Command-Line Tool

> The pulse CLI lets you manage monitors with YAML files, trigger on-demand checks, tail live logs, and gate CI/CD deployments from your terminal.

The `pulse` CLI is PulseGuard's official command-line tool. It brings your monitoring configuration into the same workflow as your code — so you can create, update, and inspect monitors without opening a browser, automate uptime checks as part of your CI/CD pipeline, and stream live events directly in your terminal.

## What you can do

Every capability of the `pulse` CLI maps to a concrete workflow:

* **Authenticate** using an API key you generate in the PulseGuard dashboard. Your credentials are stored locally by the OS-native config store, never in plain text.
* **Manage monitors via YAML** by writing a `pulseguard.yaml` file and running `pulse monitors apply`. This is Monitoring as Code — your monitor definitions live alongside your application code and are applied idempotently.
* **Trigger on-demand checks** with `pulse trigger` to run an immediate health check against any monitor without waiting for its next scheduled interval.
* **Tail live event logs** using `pulse logs tail` to stream check results to your terminal in real time — useful when debugging a degraded service.
* **Gate CI/CD deployments** with `pulse wait`, which blocks a pipeline step until a monitor reports UP or a configurable timeout is reached.

## Top-level help

Run `pulse --help` at any time to see all available commands:

```bash theme={null}
pulse --help
```

```
Usage: pulse [options] [command]

PulseGuard CLI — Monitoring as Code, live debugging, and CI/CD integration

Commands:
  auth      Authenticate with PulseGuard
  monitors  Manage monitors
  trigger   Force an immediate check
  logs      Stream monitor logs
  wait      Block until a monitor is UP (CI/CD gate)
```

Each command also accepts `--help` for detailed flag documentation. For example, `pulse monitors --help` lists all monitor subcommands.

## Where to go next

<CardGroup cols={2}>
  <Card title="Installation" icon="download" href="/cli/installation">
    Install the pulse CLI via npm, bun, or pnpm and verify your setup.
  </Card>

  <Card title="Authentication" icon="key" href="/cli/authentication">
    Generate an API key and log in to start managing monitors.
  </Card>

  <Card title="Monitors" icon="chart-line" href="/cli/monitors">
    List, inspect, apply, and export monitors using YAML files.
  </Card>

  <Card title="CI/CD Integration" icon="rocket" href="/cli/cicd-integration">
    Gate deployments on monitor health with pulse wait.
  </Card>
</CardGroup>