@knowttl/checkpoint-axi 0.0.0 → 0.1.1

package/docs/commands.md

@@ -0,0 +1,489 @@
+<!-- Generated by scripts/generate-docs.mjs from src/catalogue.ts. Do not hand-edit. -->
+
+# Command reference
+
+Inspect Check Point Email Security through compact, guarded AXI commands.
+Email, event, task and exception reads use the regional API; doctor checks authentication and one bounded search, while discovery commands stay local.
+Run each command with `--help` for concise help.
+
+[attachment download](#attachment-download) | [attachment download-all](#attachment-download-all) | [auth status](#auth-status) | [config path](#config-path) | [doctor](#doctor) | [email download](#email-download) | [email quarantine](#email-quarantine) | [email restore](#email-restore) | [email search](#email-search) | [email show](#email-show) | [event action](#event-action) | [event list](#event-list) | [event show](#event-show) | [exception clear](#exception-clear) | [exception create](#exception-create) | [exception list](#exception-list) | [exception remove](#exception-remove) | [exception remove-items](#exception-remove-items) | [exception show](#exception-show) | [exception update](#exception-update) | [home](#home) | [profile list](#profile-list) | [task show](#task-show)
+
+| Command | Purpose |
+|---|---|
+| `checkpoint-axi attachment download` | Download one attachment to a new private file with profile opt-in, a 50 MiB cap and verified x-av-sha256; scope behavior is unverified (guide pages 133-135) |
+| `checkpoint-axi attachment download-all` | Download available attachments as a ZIP to a new private file with opt-in, a 50 MiB cap and mandatory SHA-256 verification; ZIP hash availability and scopes are unverified; HTTP 200 may contain only some attachments (guide pages 135-137) |
+| `checkpoint-axi auth status` | Validate the selected local profile and secret source without API calls |
+| `checkpoint-axi config path` | Show config and state paths without reading files; --profile does not affect paths |
+| `checkpoint-axi doctor` | Check regional API authentication and one bounded email search without printing tenant data |
+| `checkpoint-axi email download` | Download an email to a new private file with profile opt-in, a 50 MiB cap and mandatory SHA-256 verification; scopes and email hash availability are unverified (guide pages 131-132) |
+| `checkpoint-axi email quarantine` | Preview or request asynchronous email quarantine through the gated write coordinator (guide pages 28-30) |
+| `checkpoint-axi email restore` | Preview or request asynchronous email restore through the gated write coordinator (guide pages 28-30) |
+| `checkpoint-axi email search` | Search emails with a bounded date window and scroll continuation (API guide pages 18-27) |
+| `checkpoint-axi email show` | Show one email with verdicts, actions and available actions (API guide pages 10-18) |
+| `checkpoint-axi event action` | Preview or request a name-only event action; parameterized actions refuse ENDPOINT_UNVERIFIED pending commissioning (guide pages 35-37, 42-45) |
+| `checkpoint-axi event list` | List security events with bounded scroll continuation (API guide pages 37-42) |
+| `checkpoint-axi event show` | Show one event, actions taken and available actions (API guide pages 34-37) |
+| `checkpoint-axi exception clear` | Refuse click-time/malware/url/dlp clear with ENDPOINT_UNVERIFIED until commissioning establishes counts and delete contracts (guide pages 87-88, 96-97, 107-110, 117-120, 128-131) |
+| `checkpoint-axi exception create` | Preview or create one exception of any kind; anomaly/click-time/malware/url/dlp response identities are unverified (guide pages 61-64, 75-78, 84-85, 91-93, 102-105, 113-116, 123-126) |
+| `checkpoint-axi exception list` | List bounded exceptions for phishing-allow, phishing-block, spam-allow, anomaly, click-time, malware, url or dlp (guide pages 49-123) |
+| `checkpoint-axi exception remove` | Preview or remove one phishing/spam/anomaly/click-time exception by ID; malware/url/dlp refuse ENDPOINT_UNVERIFIED before authentication (guide pages 67-69, 81-82, 85-87, 98-99, 108-110, 119-120, 129-131) |
+| `checkpoint-axi exception remove-items` | Preview or remove 1-20 click-time items by caller-supplied IDs; existence is unverified (guide pages 97-98) |
+| `checkpoint-axi exception show` | Show an exception by kind and ID/value; anomaly refuses ENDPOINT_UNVERIFIED pending commissioning (guide pages 52-123) |
+| `checkpoint-axi exception update` | Preview or replace one exception; phishing/spam/click-time require an ID; malware/url/dlp identify it in --input without an ID; anomaly unsupported (guide pages 64-67, 78-81, 94-96, 105-107, 116-117, 126-127) |
+| `checkpoint-axi home` | Show local profile context without resolving secrets or making API calls |
+| `checkpoint-axi profile list` | List file profiles without resolving secrets; --profile does not filter this list |
+| `checkpoint-axi task show` | Show asynchronous task status and per-action details (API guide pages 30-33) |
+
+## attachment download
+
+Download one attachment to a new private file with profile opt-in, a 50 MiB cap and verified x-av-sha256; scope behavior is unverified (guide pages 133-135)
+
+| Flag | Meaning |
+|---|---|
+| `--config` | Config path; default CHECKPOINT_AXI_CONFIG or platform path |
+| `--profile` | Profile name; default CHECKPOINT_AXI_PROFILE, env profile, config default, or sole profile |
+| `--help` | Show concise command help; default false |
+| `--out` | Required absolute new output file; mode 0600, never stdout or overwrite |
+| `--scope` | Optional authorized scope query; default profile scope when configured; live behavior unverified |
+
+```sh
+checkpoint-axi attachment download <entity-id> <attachment-id> --out /absolute/attachment
+checkpoint-axi attachment download <entity-id> <attachment-id> --scope <scope> --out /absolute/attachment
+```
+
+## attachment download-all
+
+Download available attachments as a ZIP to a new private file with opt-in, a 50 MiB cap and mandatory SHA-256 verification; ZIP hash availability and scopes are unverified; HTTP 200 may contain only some attachments (guide pages 135-137)
+
+| Flag | Meaning |
+|---|---|
+| `--config` | Config path; default CHECKPOINT_AXI_CONFIG or platform path |
+| `--profile` | Profile name; default CHECKPOINT_AXI_PROFILE, env profile, config default, or sole profile |
+| `--help` | Show concise command help; default false |
+| `--out` | Required absolute new output file; mode 0600, never stdout or overwrite |
+| `--scope` | Optional authorized scope query; default profile scope when configured; live behavior unverified |
+
+```sh
+checkpoint-axi attachment download-all <entity-id> --out /absolute/attachments
+checkpoint-axi attachment download-all <entity-id> --scope <scope> --out /absolute/attachments
+```
+
+## auth status
+
+Validate the selected local profile and secret source without API calls
+
+| Flag | Meaning |
+|---|---|
+| `--config` | Config path; default CHECKPOINT_AXI_CONFIG or platform path |
+| `--profile` | Profile name; default CHECKPOINT_AXI_PROFILE, env profile, config default, or sole profile |
+| `--fields` | Comma-separated output fields; default all |
+| `--full` | Show full strings instead of 500-character previews; default false |
+| `--help` | Show concise command help; default false |
+
+```sh
+checkpoint-axi auth status
+checkpoint-axi auth status --profile example
+```
+
+## config path
+
+Show config and state paths without reading files; --profile does not affect paths
+
+| Flag | Meaning |
+|---|---|
+| `--config` | Config path; default CHECKPOINT_AXI_CONFIG or platform path |
+| `--profile` | Profile name; default CHECKPOINT_AXI_PROFILE, env profile, config default, or sole profile |
+| `--fields` | Comma-separated output fields; default all |
+| `--full` | Show full strings instead of 500-character previews; default false |
+| `--help` | Show concise command help; default false |
+
+```sh
+checkpoint-axi config path
+checkpoint-axi config path --fields config
+```
+
+## doctor
+
+Check regional API authentication and one bounded email search without printing tenant data
+
+| Flag | Meaning |
+|---|---|
+| `--config` | Config path; default CHECKPOINT_AXI_CONFIG or platform path |
+| `--profile` | Profile name; default CHECKPOINT_AXI_PROFILE, env profile, config default, or sole profile |
+| `--fields` | Comma-separated output fields; default all |
+| `--full` | Show full strings instead of 500-character previews; default false |
+| `--help` | Show concise command help; default false |
+| `--saas` | SaaS override; default selected profile saas or office365_emails |
+
+```sh
+checkpoint-axi doctor
+checkpoint-axi doctor --profile example --saas office365_emails
+```
+
+## email download
+
+Download an email to a new private file with profile opt-in, a 50 MiB cap and mandatory SHA-256 verification; scopes and email hash availability are unverified (guide pages 131-132)
+
+| Flag | Meaning |
+|---|---|
+| `--config` | Config path; default CHECKPOINT_AXI_CONFIG or platform path |
+| `--profile` | Profile name; default CHECKPOINT_AXI_PROFILE, env profile, config default, or sole profile |
+| `--help` | Show concise command help; default false |
+| `--out` | Required absolute new output file; mode 0600, never stdout or overwrite |
+| `--original` | Download original email without processing modifications; default false |
+
+```sh
+checkpoint-axi email download <entity-id> --out /absolute/message
+checkpoint-axi email download <entity-id> --original --out /absolute/original
+```
+
+## email quarantine
+
+Preview or request asynchronous email quarantine through the gated write coordinator (guide pages 28-30)
+
+| Flag | Meaning |
+|---|---|
+| `--config` | Config path; default CHECKPOINT_AXI_CONFIG or platform path |
+| `--profile` | Profile name; default CHECKPOINT_AXI_PROFILE, env profile, config default, or sole profile |
+| `--fields` | Comma-separated output fields; default all |
+| `--full` | Show full strings instead of 500-character previews; default false |
+| `--help` | Show concise command help; default false |
+| `--ids` | Required comma-separated unique entity IDs; maximum 20 |
+| `--execute` | Send once after all write gates; default false (preview) |
+| `--dry-run` | Explicit preview; cannot combine with --execute |
+| `--confirm` | Exact operation followed by a space and the comma-separated IDs in supplied order |
+
+```sh
+checkpoint-axi email quarantine --ids <id>
+checkpoint-axi email quarantine --ids <id> --execute --confirm 'email.quarantine <id>'
+```
+
+## email restore
+
+Preview or request asynchronous email restore through the gated write coordinator (guide pages 28-30)
+
+| Flag | Meaning |
+|---|---|
+| `--config` | Config path; default CHECKPOINT_AXI_CONFIG or platform path |
+| `--profile` | Profile name; default CHECKPOINT_AXI_PROFILE, env profile, config default, or sole profile |
+| `--fields` | Comma-separated output fields; default all |
+| `--full` | Show full strings instead of 500-character previews; default false |
+| `--help` | Show concise command help; default false |
+| `--ids` | Required comma-separated unique entity IDs; maximum 20 |
+| `--execute` | Send once after all write gates; default false (preview) |
+| `--dry-run` | Explicit preview; cannot combine with --execute |
+| `--confirm` | Exact operation followed by a space and the comma-separated IDs in supplied order |
+
+```sh
+checkpoint-axi email restore --ids <id>
+checkpoint-axi email restore --ids <id> --execute --confirm 'email.restore <id>'
+```
+
+## email search
+
+Search emails with a bounded date window and scroll continuation (API guide pages 18-27)
+
+| Flag | Meaning |
+|---|---|
+| `--config` | Config path; default CHECKPOINT_AXI_CONFIG or platform path |
+| `--profile` | Profile name; default CHECKPOINT_AXI_PROFILE, env profile, config default, or sole profile |
+| `--fields` | Comma-separated output fields; default all |
+| `--full` | Show full strings instead of 500-character previews; default false |
+| `--help` | Show concise command help; default false |
+| `--saas` | SaaS override; default selected profile saas or office365_emails |
+| `--saas-entity` | Optional SaaS entity type selector |
+| `--start-date` | ISO timestamp with timezone; default 24 hours before end-date; maximum window 31 days |
+| `--end-date` | ISO timestamp with timezone; default now |
+| `--limit` | Maximum rows; default 50, range 1-1000; cannot combine with --all |
+| `--all` | Read up to 1000 rows / 10 HTTP requests / 60 seconds / 8 MiB; default false |
+| `--cursor` | Opaque continuation bound to profile, region, operation and selectors; repeat original selectors |
+| `--filter` | JSON array of {saasAttrName, saasAttrOp, saasAttrValue} filters (guide pages 19-20) |
+
+```sh
+checkpoint-axi email search
+checkpoint-axi email search --all --saas office365_emails
+checkpoint-axi email search --cursor <cursor>
+```
+
+## email show
+
+Show one email with verdicts, actions and available actions (API guide pages 10-18)
+
+| Flag | Meaning |
+|---|---|
+| `--config` | Config path; default CHECKPOINT_AXI_CONFIG or platform path |
+| `--profile` | Profile name; default CHECKPOINT_AXI_PROFILE, env profile, config default, or sole profile |
+| `--fields` | Comma-separated output fields; default all |
+| `--full` | Show full strings instead of 500-character previews; default false |
+| `--help` | Show concise command help; default false |
+
+```sh
+checkpoint-axi email show <id>
+checkpoint-axi email show <id> --full
+```
+
+## event action
+
+Preview or request a name-only event action; parameterized actions refuse ENDPOINT_UNVERIFIED pending commissioning (guide pages 35-37, 42-45)
+
+| Flag | Meaning |
+|---|---|
+| `--config` | Config path; default CHECKPOINT_AXI_CONFIG or platform path |
+| `--profile` | Profile name; default CHECKPOINT_AXI_PROFILE, env profile, config default, or sole profile |
+| `--fields` | Comma-separated output fields; default all |
+| `--full` | Show full strings instead of 500-character previews; default false |
+| `--help` | Show concise command help; default false |
+| `--ids` | Required comma-separated unique event IDs; maximum 20 |
+| `--execute` | Send once after all write gates; default false (preview) |
+| `--dry-run` | Explicit preview; cannot combine with --execute |
+| `--confirm` | Exact operation followed by a space and the comma-separated IDs in supplied order |
+| `--name` | Required available action name; nonempty action parameters are unverified |
+
+```sh
+checkpoint-axi event action --ids <id> --name dismiss
+checkpoint-axi event action --ids <id> --name dismiss --execute --confirm 'event.action.dismiss <id>'
+```
+
+## event list
+
+List security events with bounded scroll continuation (API guide pages 37-42)
+
+| Flag | Meaning |
+|---|---|
+| `--config` | Config path; default CHECKPOINT_AXI_CONFIG or platform path |
+| `--profile` | Profile name; default CHECKPOINT_AXI_PROFILE, env profile, config default, or sole profile |
+| `--fields` | Comma-separated output fields; default all |
+| `--full` | Show full strings instead of 500-character previews; default false |
+| `--help` | Show concise command help; default false |
+| `--start-date` | ISO timestamp with timezone; default 24 hours before end-date; maximum window 31 days |
+| `--end-date` | ISO timestamp with timezone; default now |
+| `--limit` | Maximum rows; default 50, range 1-1000; cannot combine with --all |
+| `--all` | Read up to 1000 rows / 10 HTTP requests / 60 seconds / 8 MiB; default false |
+| `--cursor` | Opaque continuation bound to profile, region, operation and selectors; repeat original selectors |
+| `--saas` | Comma-separated SaaS overrides; default selected profile saas or office365_emails |
+| `--event-types` | Comma-separated event types; default unfiltered |
+| `--event-states` | Comma-separated event states; default unfiltered |
+| `--severities` | Comma-separated severities; default unfiltered |
+| `--event-ids` | Comma-separated event IDs; default unfiltered |
+| `--confidence-indicator` | Confidence indicator selector; default unfiltered |
+| `--description` | Description selector; default unfiltered |
+
+```sh
+checkpoint-axi event list
+checkpoint-axi event list --all --event-types phishing
+checkpoint-axi event list --cursor <cursor>
+```
+
+## event show
+
+Show one event, actions taken and available actions (API guide pages 34-37)
+
+| Flag | Meaning |
+|---|---|
+| `--config` | Config path; default CHECKPOINT_AXI_CONFIG or platform path |
+| `--profile` | Profile name; default CHECKPOINT_AXI_PROFILE, env profile, config default, or sole profile |
+| `--fields` | Comma-separated output fields; default all |
+| `--full` | Show full strings instead of 500-character previews; default false |
+| `--help` | Show concise command help; default false |
+
+```sh
+checkpoint-axi event show <id>
+checkpoint-axi event show <id> --full
+```
+
+## exception clear
+
+Refuse click-time/malware/url/dlp clear with ENDPOINT_UNVERIFIED until commissioning establishes counts and delete contracts (guide pages 87-88, 96-97, 107-110, 117-120, 128-131)
+
+| Flag | Meaning |
+|---|---|
+| `--config` | Config path; default CHECKPOINT_AXI_CONFIG or platform path |
+| `--profile` | Profile name; default CHECKPOINT_AXI_PROFILE, env profile, config default, or sole profile |
+| `--fields` | Comma-separated output fields; default all |
+| `--full` | Show full strings instead of 500-character previews; default false |
+| `--help` | Show concise command help; default false |
+| `--execute` | Send once after all write gates; default false (preview) |
+| `--dry-run` | Explicit preview; cannot combine with --execute |
+| `--confirm` | Exact operation followed by a space and every target from preview (payload sha256 for create and malware/url/dlp update, exception ID or comma-separated item IDs otherwise) |
+
+```sh
+checkpoint-axi exception clear click-time
+checkpoint-axi exception clear click-time --dry-run
+```
+
+## exception create
+
+Preview or create one exception of any kind; anomaly/click-time/malware/url/dlp response identities are unverified (guide pages 61-64, 75-78, 84-85, 91-93, 102-105, 113-116, 123-126)
+
+| Flag | Meaning |
+|---|---|
+| `--config` | Config path; default CHECKPOINT_AXI_CONFIG or platform path |
+| `--profile` | Profile name; default CHECKPOINT_AXI_PROFILE, env profile, config default, or sole profile |
+| `--fields` | Comma-separated output fields; default all |
+| `--full` | Show full strings instead of 500-character previews; default false |
+| `--help` | Show concise command help; default false |
+| `--execute` | Send once after all write gates; default false (preview) |
+| `--dry-run` | Explicit preview; cannot combine with --execute |
+| `--confirm` | Exact operation followed by a space and every target from preview (payload sha256 for create and malware/url/dlp update, exception ID or comma-separated item IDs otherwise) |
+| `--input` | Required absolute private JSON file containing documented requestData fields directly; fields depend on kind; update sends a replacement PUT |
+| `--specific` | Malware/url/dlp only: use the documented create-specific /exceptions route; default false; included in confirmation digest |
+
+```sh
+checkpoint-axi exception create phishing-allow --input /absolute/rule.json
+checkpoint-axi exception create spam-allow --input /absolute/rule.json --execute --confirm 'exception.spam-allow.create sha256:<preview-digest>'
+```
+
+## exception list
+
+List bounded exceptions for phishing-allow, phishing-block, spam-allow, anomaly, click-time, malware, url or dlp (guide pages 49-123)
+
+| Flag | Meaning |
+|---|---|
+| `--config` | Config path; default CHECKPOINT_AXI_CONFIG or platform path |
+| `--profile` | Profile name; default CHECKPOINT_AXI_PROFILE, env profile, config default, or sole profile |
+| `--fields` | Comma-separated output fields; default all |
+| `--full` | Show full strings instead of 500-character previews; default false |
+| `--help` | Show concise command help; default false |
+| `--type` | Required for malware: hash,micro_hash,file_type,ppat_sender_name,allow_file_type,sender_email; url: allow-url,allow-domain,block-url,block-domain; dlp: hash,text_content,sender_email,recipient_email |
+| `--items` | Click-time item routes instead of list routes; default false |
+| `--limit` | Maximum rows; default 50, range 1-1000; cannot combine with --all |
+| `--all` | Return up to 1000 rows within transport budgets; no server continuation parameter is documented |
+
+```sh
+checkpoint-axi exception list phishing-allow
+checkpoint-axi exception list malware --type hash
+checkpoint-axi exception list click-time --items --all
+```
+
+## exception remove
+
+Preview or remove one phishing/spam/anomaly/click-time exception by ID; malware/url/dlp refuse ENDPOINT_UNVERIFIED before authentication (guide pages 67-69, 81-82, 85-87, 98-99, 108-110, 119-120, 129-131)
+
+| Flag | Meaning |
+|---|---|
+| `--config` | Config path; default CHECKPOINT_AXI_CONFIG or platform path |
+| `--profile` | Profile name; default CHECKPOINT_AXI_PROFILE, env profile, config default, or sole profile |
+| `--fields` | Comma-separated output fields; default all |
+| `--full` | Show full strings instead of 500-character previews; default false |
+| `--help` | Show concise command help; default false |
+| `--execute` | Send once after all write gates; default false (preview) |
+| `--dry-run` | Explicit preview; cannot combine with --execute |
+| `--confirm` | Exact operation followed by a space and every target from preview (payload sha256 for create and malware/url/dlp update, exception ID or comma-separated item IDs otherwise) |
+
+```sh
+checkpoint-axi exception remove phishing-allow <id>
+checkpoint-axi exception remove spam-allow <id> --execute --confirm 'exception.spam-allow.remove <id>'
+```
+
+## exception remove-items
+
+Preview or remove 1-20 click-time items by caller-supplied IDs; existence is unverified (guide pages 97-98)
+
+| Flag | Meaning |
+|---|---|
+| `--config` | Config path; default CHECKPOINT_AXI_CONFIG or platform path |
+| `--profile` | Profile name; default CHECKPOINT_AXI_PROFILE, env profile, config default, or sole profile |
+| `--fields` | Comma-separated output fields; default all |
+| `--full` | Show full strings instead of 500-character previews; default false |
+| `--help` | Show concise command help; default false |
+| `--execute` | Send once after all write gates; default false (preview) |
+| `--dry-run` | Explicit preview; cannot combine with --execute |
+| `--confirm` | Exact operation followed by a space and every target from preview (payload sha256 for create and malware/url/dlp update, exception ID or comma-separated item IDs otherwise) |
+| `--ids` | Required 1-20 unique comma-separated click-time item IDs |
+
+```sh
+checkpoint-axi exception remove-items click-time --ids <id1>,<id2>
+checkpoint-axi exception remove-items click-time --ids <id1>,<id2> --execute --confirm 'exception.click-time.remove-items <id1>,<id2>'
+```
+
+## exception show
+
+Show an exception by kind and ID/value; anomaly refuses ENDPOINT_UNVERIFIED pending commissioning (guide pages 52-123)
+
+| Flag | Meaning |
+|---|---|
+| `--config` | Config path; default CHECKPOINT_AXI_CONFIG or platform path |
+| `--profile` | Profile name; default CHECKPOINT_AXI_PROFILE, env profile, config default, or sole profile |
+| `--fields` | Comma-separated output fields; default all |
+| `--full` | Show full strings instead of 500-character previews; default false |
+| `--help` | Show concise command help; default false |
+| `--type` | Required for malware: hash,micro_hash,file_type,ppat_sender_name,allow_file_type,sender_email; url: allow-url,allow-domain,block-url,block-domain; dlp: hash,text_content,sender_email,recipient_email |
+| `--items` | Click-time item route instead of list route; default false |
+
+```sh
+checkpoint-axi exception show phishing-block <id>
+checkpoint-axi exception show url <value> --type allow-url
+checkpoint-axi exception show click-time <id> --items --full
+```
+
+## exception update
+
+Preview or replace one exception; phishing/spam/click-time require an ID; malware/url/dlp identify it in --input without an ID; anomaly unsupported (guide pages 64-67, 78-81, 94-96, 105-107, 116-117, 126-127)
+
+| Flag | Meaning |
+|---|---|
+| `--config` | Config path; default CHECKPOINT_AXI_CONFIG or platform path |
+| `--profile` | Profile name; default CHECKPOINT_AXI_PROFILE, env profile, config default, or sole profile |
+| `--fields` | Comma-separated output fields; default all |
+| `--full` | Show full strings instead of 500-character previews; default false |
+| `--help` | Show concise command help; default false |
+| `--execute` | Send once after all write gates; default false (preview) |
+| `--dry-run` | Explicit preview; cannot combine with --execute |
+| `--confirm` | Exact operation followed by a space and every target from preview (payload sha256 for create and malware/url/dlp update, exception ID or comma-separated item IDs otherwise) |
+| `--input` | Required absolute private JSON file containing documented requestData fields directly; fields depend on kind; update sends a replacement PUT |
+
+```sh
+checkpoint-axi exception update phishing-block <id> --input /absolute/rule.json
+checkpoint-axi exception update spam-allow <id> --input /absolute/rule.json --execute --confirm 'exception.spam-allow.update <id>'
+```
+
+## home
+
+Show local profile context without resolving secrets or making API calls
+
+| Flag | Meaning |
+|---|---|
+| `--config` | Config path; default CHECKPOINT_AXI_CONFIG or platform path |
+| `--profile` | Profile name; default CHECKPOINT_AXI_PROFILE, env profile, config default, or sole profile |
+| `--fields` | Comma-separated output fields; default all |
+| `--full` | Show full strings instead of 500-character previews; default false |
+| `--help` | Show concise command help; default false |
+
+```sh
+checkpoint-axi
+checkpoint-axi home --profile example
+```
+
+## profile list
+
+List file profiles without resolving secrets; --profile does not filter this list
+
+| Flag | Meaning |
+|---|---|
+| `--config` | Config path; default CHECKPOINT_AXI_CONFIG or platform path |
+| `--profile` | Profile name; default CHECKPOINT_AXI_PROFILE, env profile, config default, or sole profile |
+| `--fields` | Comma-separated output fields; default all |
+| `--full` | Show full strings instead of 500-character previews; default false |
+| `--help` | Show concise command help; default false |
+
+```sh
+checkpoint-axi profile list
+checkpoint-axi profile list --config /example/config.json
+```
+
+## task show
+
+Show asynchronous task status and per-action details (API guide pages 30-33)
+
+| Flag | Meaning |
+|---|---|
+| `--config` | Config path; default CHECKPOINT_AXI_CONFIG or platform path |
+| `--profile` | Profile name; default CHECKPOINT_AXI_PROFILE, env profile, config default, or sole profile |
+| `--fields` | Comma-separated output fields; default all |
+| `--full` | Show full strings instead of 500-character previews; default false |
+| `--help` | Show concise command help; default false |
+
+```sh
+checkpoint-axi task show <id>
+checkpoint-axi task show <id> --full
+```

package/docs/configuration.md

@@ -0,0 +1,63 @@
+# Configuration
+
+See [environment variables and platform defaults](../README.md#configuration) for the complete variable table.
+
+`config path` reports platform paths without reading files.
+Config defaults to `$XDG_CONFIG_HOME/checkpoint-axi/config.json` (or `~/.config/checkpoint-axi/config.json`) on Linux/macOS, and `%APPDATA%\checkpoint-axi\config.json` on Windows.
+State defaults to `$XDG_STATE_HOME/checkpoint-axi` (or `~/.local/state/checkpoint-axi`), and `%LOCALAPPDATA%\checkpoint-axi` on Windows.
+Windows ignores XDG variables.
+XDG and Windows base-directory overrides must be absolute; relative values use the platform defaults.
+If APPDATA or LOCALAPPDATA is absent or relative, the Windows defaults are `~/AppData/Roaming` and `~/AppData/Local` respectively.
+No command discovers config from the current directory or writes configuration.
+
+Create a config file with this synthetic shape and protect it from group/other writes:
+
+```json
+{
+  "version": 1,
+  "defaultProfile": "example",
+  "profiles": {
+    "example": {
+      "region": "eu",
+      "clientId": "synthetic-client",
+      "clientSecret": { "env": "CHECKPOINT_AXI_CLIENT_SECRET" },
+      "saas": "office365_emails",
+      "downloads": { "allow": false },
+      "writes": { "allowWrites": false, "operations": [] }
+    }
+  }
+}
+```
+
+Supply the secret through your environment or an absolute private file SecretRef, never chat, argv or an inline config value.
+Omitting `clientSecret` defaults its reference to `CHECKPOINT_AXI_CLIENT_SECRET`.
+`auth status` resolves the selected reference locally and reports only its kind (`env` or `file`); it never prints the value, client ID, variable name or secret file path.
+It confirms local readiness, not API authentication.
+`profile list` and home never resolve secret files.
+Supported regions are `us`, `eu`, `ca`, `au`, `uk`, `uae` and `in`; there is no origin override.
+Optional `saas` defaults to `office365_emails`; `doctor`, `email search` and `event list` accept `--saas <name>` to override it for that call.
+Optional `scope` supplies the required email download `scopes` header and the default optional attachment `scope` query.
+The host-facing [credential schema](../axi-credential.schema.json) describes one strict profile.
+
+Config precedence is `--config`, then `CHECKPOINT_AXI_CONFIG`, then the platform path.
+Profile precedence is `--profile`, `CHECKPOINT_AXI_PROFILE`, complete env profile, config default, sole file profile, then an explicit missing/ambiguous error.
+An env profile requires `CHECKPOINT_AXI_REGION`, `CHECKPOINT_AXI_CLIENT_ID` and `CHECKPOINT_AXI_CLIENT_SECRET` together; optional `CHECKPOINT_AXI_SAAS` and `CHECKPOINT_AXI_SCOPE` cannot stand alone.
+File-selected metadata never mixes with env-profile fields, though an explicit SecretRef can name an environment variable.
+Environment profiles always disable writes and downloads.
+`CHECKPOINT_AXI_READ_ONLY` accepts `1`/`true` or `0`/`false` case-insensitively; any other value fails closed.
+`CHECKPOINT_AXI_WRITE_LOG` overrides the write journal, defaulting to `writes.log` in the platform state directory.
+An empty override uses that default.
+
+POSIX reads reject symlinks, foreign ownership, group/other-writable config and any group/other access to secret files.
+Secret file content is UTF-8 with a leading BOM and trailing whitespace removed.
+On Windows, regular files and reparse points are checked without interpreting mode bits; `auth status`, `doctor` and email, event, task and exception API commands also verify a protected DACL for the current user, SYSTEM and Administrators.
+
+## Write and download permissions
+
+File profiles are read-only by default.
+Set `writes.allowWrites` to true and list each exact operation in the `writes` object's `operations` array only when that permission is intended.
+Environment profiles cannot enable writes or downloads.
+`CHECKPOINT_AXI_READ_ONLY=1` overrides all configured write permission.
+Downloads require the separate `downloads.allow: true` file-profile opt-in.
+See [operation gates](writes.md) and [download requirements](downloads.md); profile permission alone does not execute an operation.
+