> For the complete documentation index, see [llms.txt](https://docs.augustdigital.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.augustdigital.io/developers/cli.md).

# CLI (august)

Read-only command-line client for August Digital vaults and Upshift pools.

## Quickstart

```bash
npm install -g @augustdigital/cli

august init                 # one-time: encrypted keystore + config
august whoami               # confirm config dir + API-key source
august vault list           # discover vault names and addresses
august vault apy eth-coreusdc
```

Every command accepts `--json` (stable envelope, `schemaVersion: 1`) and `--csv` for list-shaped output. Vault arguments accept a raw address, a bare symbol (`coreusdc`), or a chain-prefixed symbol (`eth-coreusdc`).

## Data commands

```bash
august points leaderboard --per-page 10 --sort-by totalPoints
august vault pending-redemptions <vault>     # backend redemption queue
august vault pnl-history <vault> --limit 30  # unrealized-PnL series
august vault pnl-latest                      # latest snapshot, every vault
august user pnl <wallet> --vault <vault>
```

## Ops commands

```bash
august ops health --vault eth-coreusdc       # RPC + summary + queue sweep
august ops redemptions <vault> --watch 30    # poll queue health every 30s
```

Exit codes: `0` all clear, `1` execution error, `2` anomalies found — cron a non-zero exit to alert. `--watch <seconds>` re-renders in place, or emits NDJSON (one envelope per tick) with `--json`.

## Reference

The full command map, envelope format, and error codes live in the [package README](https://github.com/fractal-protocol/js-sdk/tree/main/packages/cli) and the bundled Claude Code skill (`august skill install`).