## CLI
The package ships a `bin` binary so you can smoke-check connectivity without writing code:
```bash theme={null}
# With the env var set:
export ANOMALYARMOR_API_KEY=aa_live_...
npx anomalyarmor health
# Or pass the key directly:
npx anomalyarmor health --api-key aa_live_...
```
The CLI has exactly one command (`health`) by design - anything richer belongs in a real script calling the library API.
## Rate limiting & retries
The SDK automatically retries HTTP 429 responses, honoring `Retry-After`. Retries are bounded (default 3 attempts, each sleep capped at 60 s) and only apply to idempotent verbs (`GET`, `HEAD`, `PUT`, `DELETE`, `OPTIONS`) so a `POST` failure never duplicates a side effect.
Tune or disable:
```ts theme={null}
const client = createAnomalyArmorClient({
apiKey: '...',
maxRetries: 5, // default 3
maxRetrySleepSeconds: 120, // default 60
});
// Opt out of retries entirely (mutation-heavy callers who want explicit control):
const client = createAnomalyArmorClient({ apiKey: '...', maxRetries: 0 });
```
## How requests work
Every typed SDK call flows through six layers: the ergonomic helper → `openapi-fetch` → the middleware stack → platform `fetch` → parse / unwrap → a statically-typed response.
## Error handling
Ergonomic methods throw `AnomalyArmorApiError` on 4xx / 5xx responses:
```ts theme={null}
import { AnomalyArmorApiError } from '@anomalyarmor/sdk';
try {
await client.alerts.get('does-not-exist');
} catch (err) {
if (err instanceof AnomalyArmorApiError) {
console.error(`HTTP ${err.status}: ${err.message}`);
console.error('Full body:', err.body);
} else {
throw err; // network / parse / programmer errors
}
}
```
## Drop down to the raw client
The ergonomic surface covers the endpoints customers use most often. For anything else, `client.raw` exposes the full typed `openapi-fetch` client:
```ts theme={null}
const { data, error } = await client.raw.GET('/api/v1/assets/{asset_id}', {
params: { path: { asset_id: 'my-asset' } },
});
if (error) throw new Error(`asset lookup failed: ${error.message}`);
// data is typed from the OpenAPI spec
```
## Configuration reference
| Option | Default | Purpose |
| ---------------------- | ----------------------------- | -------------------------------------------------- |
| `apiKey` | *(required)* | Your `aa_live_*` Bearer token. |
| `baseUrl` | `https://app.anomalyarmor.ai` | Override for staging or a local backend. |
| `maxRetries` | `3` | 429-retry budget. Set to `0` to disable. |
| `maxRetrySleepSeconds` | `60` | Cap on any single `Retry-After` sleep. |
| `fetch` | `globalThis.fetch` | Injectable `fetch` for tests / alternate runtimes. |
## Next steps