work
This commit is contained in:
24
docs/modules/cli/guides/commands/notify.md
Normal file
24
docs/modules/cli/guides/commands/notify.md
Normal file
@@ -0,0 +1,24 @@
|
||||
# stella notify — Command Guide
|
||||
|
||||
## Commands
|
||||
- `stella notify send --channel <email|chat|webhook> --template <id> --data <file>`
|
||||
- `stella notify list --status <pending|sent|failed> [--output json|table] [--offline]`
|
||||
- `stella notify get --id <messageId> [--offline]`
|
||||
|
||||
## Flags (common)
|
||||
- `--offline`: only allowed when notification queue snapshots are cached; otherwise exit code 5.
|
||||
- `--tenant`: scope to tenant; enforced by server RLS.
|
||||
- `--output`: json/ndjson/table.
|
||||
|
||||
## Inputs/outputs
|
||||
- Inputs: Notify API; optional cached queue snapshots when offline.
|
||||
- Outputs: message metadata, status, delivery results; no template content leaks.
|
||||
- Exit codes follow `output-and-exit-codes.md`; 4 for not found, 5 for offline violation.
|
||||
|
||||
## Determinism rules
|
||||
- Listings sorted by created time then id; timestamps UTC.
|
||||
- No retries triggered by the CLI; it only submits/reads.
|
||||
|
||||
## Offline/air-gap notes
|
||||
- Sending in offline mode is disallowed (exit code 5); only listing cached snapshots is permitted.
|
||||
- Templates must be preloaded; no remote fetches when `--offline`.
|
||||
Reference in New Issue
Block a user