61 lines
1.6 KiB
Markdown
61 lines
1.6 KiB
Markdown
---
|
|
name: "agentmail-shared"
|
|
description: "agentmail CLI: Shared patterns for authentication, global flags, and output formatting."
|
|
---
|
|
|
|
# agentmail — Shared Reference
|
|
|
|
## Authentication
|
|
|
|
- **BearerAuth** (bearer token): `AGENTMAIL_API_KEY` env var or keyring `agentmail:BearerAuth` (populated by `auth login`)
|
|
- **TokenAuth** (bearer token): `AGENTMAIL_TOKEN` env var or keyring `agentmail:TokenAuth` (populated by `auth login`)
|
|
|
|
These are alternative schemes for the same request — set **one** of:
|
|
|
|
```bash
|
|
export AGENTMAIL_API_KEY="<your-token>"
|
|
export AGENTMAIL_TOKEN="<your-token>"
|
|
```
|
|
|
|
Verify authentication resolves:
|
|
|
|
```bash
|
|
agentmail auth status
|
|
```
|
|
|
|
## Global Flags
|
|
|
|
These flags are available on every command in this CLI.
|
|
|
|
| Flag | Description | Default |
|
|
|------|-------------|---------|
|
|
| `--dry-run` | Validate locally without sending the request | |
|
|
| `--format <FMT>` | Output format: `json`, `table`, `yaml`, `csv`, `raw`, `jsonl`, `http` | `table` on a TTY, `json` when piped |
|
|
| `--base-url <URL>` | Override the API base URL | |
|
|
| `--params <JSON>` | URL/query/path parameters as JSON | |
|
|
| `--json <JSON>` | Request body for POST/PATCH/PUT | |
|
|
| `--no-retry` | Disable retries | |
|
|
| `--no-extract` | Print the full response body | |
|
|
|
|
## Output Formatting
|
|
|
|
```bash
|
|
# JSON (default)
|
|
agentmail <resource> <method> --format json
|
|
|
|
# Table view
|
|
agentmail <resource> <method> --format table
|
|
|
|
# Pipe-friendly: jq, grep, etc.
|
|
agentmail <resource> <method> | jq '.fieldName'
|
|
```
|
|
|
|
## Dry Run
|
|
|
|
Use `--dry-run` to preview the HTTP request without sending it:
|
|
|
|
```bash
|
|
agentmail <resource> <method> --dry-run
|
|
```
|
|
|