---
title: Core commands
description: Session and discovery commands: status, health, whoami, login, logout, version, introspect.
---

# Core commands



{/* AUTO-GENERATED by scripts/generate-cli-reference.mjs from `argusctl introspect --json`.
    Do not edit by hand. Regenerate with: pnpm generate:cli */}

> Generated from argusctl v0.1.0 on 2026-06-09. Run `argusctl introspect --json` for the machine-readable tree.

## `argusctl status`

One-screen platform health: api/db/r2, tenants armed, agents online, pods running.

```bash
argusctl status [options]
```

| Option              | Description                                              |
| ------------------- | -------------------------------------------------------- |
| `--watch [seconds]` | live refresh every N seconds (default 5); Ctrl+C to stop |
| `--api <url>`       | API base URL                                             |
| `--token <pat>`     | PAT to use                                               |
| `--json`            | JSON output                                              |
| `--fields <list>`   | comma-separated fields to include                        |

## `argusctl health`

Probe api.useargus.co/health (no auth required).

```bash
argusctl health [options]
```

| Option            | Description                       |
| ----------------- | --------------------------------- |
| `--api <url>`     | API base URL                      |
| `--json`          | JSON output                       |
| `--fields <list>` | comma-separated fields to include |

## `argusctl whoami`

Print the principal that the configured PAT resolves to.

```bash
argusctl whoami [options]
```

| Option            | Description                              |
| ----------------- | ---------------------------------------- |
| `--api <url>`     | API base URL                             |
| `--token <pat>`   | PAT to use instead of the configured one |
| `--json`          | JSON output                              |
| `--fields <list>` | comma-separated fields to include        |

## `argusctl login`

Store an Argus Ops PAT at \~/.config/argus/token (chmod 600). From --token or stdin.

```bash
argusctl login [options]
```

| Option          | Description                             |
| --------------- | --------------------------------------- |
| `--token <pat>` | the PAT to store (else read from stdin) |
| `--json`        | JSON output                             |

## `argusctl logout`

Remove the stored PAT (\~/.config/argus/token).

```bash
argusctl logout [options]
```

| Option   | Description |
| -------- | ----------- |
| `--json` | JSON output |

## `argusctl version`

Print argusctl version.

```bash
argusctl version
```

## `argusctl introspect`

Dump the full command tree (for AI agents).

```bash
argusctl introspect [options]
```

| Option   | Description           |
| -------- | --------------------- |
| `--json` | JSON output (default) |

## `argusctl completion`

Print a shell completion script (source it: source \<(argusctl completion bash)).

```bash
argusctl completion [shell]
```

| Argument | Required |
| -------- | -------- |
| `shell`  | no       |

## Examples

```bash
argusctl login --token pat_...   # store a PAT at ~/.config/argus/token (chmod 600)
argusctl status                  # one-screen overview: api/db/r2, tenants armed, agents online, pods
argusctl whoami
argusctl introspect --json       # discover the full command tree (for AI agents)
```


---

For a semantic overview of all documentation, see [/sitemap.md](/sitemap.md)

For an index of all available documentation, see [/llms.txt](/llms.txt)

For agent-facing discovery, including API and MCP surfaces, see [/agents.md](/agents.md)