coss-cli 0.6.0 → 0.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +41 -5
- package/dist/cli.js +1 -1
- package/dist/index.js +1 -1
- package/dist/{run-C97BDtxr.js → run-kad9znCz.js} +9404 -3762
- package/package.json +12 -4
package/README.md
CHANGED
|
@@ -39,15 +39,38 @@ ID and notarized by Apple (since 0.3.0), so one downloaded with a browser runs w
|
|
|
39
39
|
| `coss whoami` | The key in use, where it comes from, and its organization, project and environment. |
|
|
40
40
|
| `coss profiles list` | The saved profiles: each one's environment, whether `coss login` created its key or it was pasted, and which is the default. |
|
|
41
41
|
| `coss use <profile>` | Makes a saved profile the default. |
|
|
42
|
-
| `coss init` | Sets the project in the current directory up: installs `coss` with its package manager (`--no-install` doesn't) and writes a new development key, approved in the dashboard and named after the project, to `.env.local` (Next.js) or `.env` (`--env-file` picks another). A key already there is kept unless `--force`. It adds notes on coss.com for coding agents to the project's `AGENTS.md` (`--no-agents` skips them) and prints the one next step for the key. |
|
|
43
|
-
| `coss open [page]` | Opens the environment's page in the dashboard: `overview`, `emails`, `logs`, `webhooks`, `api-keys`, `domains`, `billing`, … (`--print` prints the URL). |
|
|
42
|
+
| `coss init` | Sets the project in the current directory up: installs `coss` with its package manager (`--no-install` doesn't) and writes a new development key, approved in the dashboard and named after the project, to `.env.local` (Next.js) or `.env` (`--env-file` picks another). A key already there is kept unless `--force`. It adds notes on coss.com for coding agents to the project's `AGENTS.md` (`--no-agents` skips them) and prints the one next step for the key (`--product sms`: that product's). |
|
|
43
|
+
| `coss open [page]` | Opens the environment's page in the dashboard: `overview`, `emails`, `logs`, `webhooks`, `api-keys`, `domains`, `risk-rules`, `scheduling-hosts`, `billing`, … (`--print` prints the URL; `coss open --help` lists them). |
|
|
44
44
|
| `coss emails send` | A test email: `--to`, or `--simulate delivered\|bounced\|complained\|suppressed` for the mailbox simulator; `--template` with `--var name=value`; `--wait` follows it to its outcome (up to `--timeout`, 60 s). |
|
|
45
45
|
| `coss emails list` | The environment's emails, newest first, with where each stands. Filter with `--to`, `--status`, `--recipient-status`, `-q`, `--category`, `--batch`, `--since`/`--until`; `--limit` (20). |
|
|
46
46
|
| `coss emails get <id>` | An email: sender, recipients and their statuses, failure, tracking, attachments; `--text` or `--html` prints a body alone. |
|
|
47
47
|
| `coss emails events <id>` | Its delivery events, with the receiving server's answers. |
|
|
48
48
|
| `coss emails diagnose <id>` | Whether it was delivered and, if not, why and what to do (or `--to <address>` for the newest email to it). |
|
|
49
|
+
| `coss emails cancel <email>`, `coss emails reschedule <email> --at <time>` | Cancels or moves a scheduled email. A time that has passed sends it right away, so a live key asks first (`--yes` off a terminal). |
|
|
50
|
+
| `coss suppressions list`, `coss suppressions check <address>`, `coss suppressions add <address>`, `coss suppressions remove <suppression>` | The [addresses that won't be emailed](https://coss.com/docs/email/suppressions) (`--scope`, `--subaccount`; `check` takes `--category`, `--stream`). |
|
|
51
|
+
| `coss subaccounts list`, `coss subaccounts get <subaccount>`, `coss subaccounts create <name>`, `coss subaccounts update <subaccount>`, `coss subaccounts delete <subaccount>`, `coss subaccounts reinstate <subaccount>`, `coss subaccounts stats <subaccount>` | [Sub-accounts](https://coss.com/docs/email/subaccounts) for your users, by id or uid (`--uid`, `--metadata`, `--per-day`, `--per-second`, `--burst`; `update` takes `--status`; `stats` takes `--from`, `--to`). `delete` can't be undone, so a live key asks first (`--yes` off a terminal). |
|
|
49
52
|
| `coss sms send` | A test text message: `--to +14155550123`, or `--simulate delivered\|invalid\|filtered\|opted-out\|reply` for the SMS simulator (sandbox keys); `--from` (default for sandbox keys `+14155550100`; live keys need one of your registered numbers), `--body`; `--wait` follows it to its outcome (and shows the simulator's reply). |
|
|
53
|
+
| `coss sms list`, `coss sms get <message>`, `coss sms cancel <message>`, `coss sms received`, `coss sms numbers` | Messages and their events, cancelling a scheduled one, what your numbers received, and which numbers can send. |
|
|
54
|
+
| `coss sms diagnose <message>` | Whether it was delivered and, if not, why and what to do (or `--to <number>` for the newest message to it). |
|
|
55
|
+
| `coss sms suppressions list`, `coss sms suppressions check <number>`, `coss sms suppressions add <number>`, `coss sms suppressions remove <suppression>` | The numbers that won't be texted. |
|
|
56
|
+
| `coss verify start <to>`, `coss verify check --code <code>` | [One-time codes](https://coss.com/docs/verify): sends one, and compares what the end user typed (`--id` or `--to`; exits 0 only when it's right). |
|
|
57
|
+
| `coss verify list`, `coss verify get <verification>`, `coss verify cancel <verification>` | Verifications and what happened to each. |
|
|
58
|
+
| `coss verify settings get`, `coss verify settings set` | Code length, lifetime and attempts, the senders and allowed countries. |
|
|
59
|
+
| `coss verify diagnose <verification>` | Why no code arrived or a check failed (or `--to <to>` for the newest one). Never shows a code. |
|
|
60
|
+
| `coss contacts list`, `coss contacts get <contact>`, `coss contacts add <email>`, `coss contacts update <contact>`, `coss contacts remove <contact>` | [Marketing contacts](https://coss.com/docs/email/contacts) (`update`: `--first-name`, `--last-name`, `--status`, `--property name=value`, `--data`). |
|
|
61
|
+
| `coss contacts import <file>`, `coss contacts export` | Contacts from a CSV or JSON file (`-` for stdin, `--audience`; exits 1 when it skipped a row), and as CSV (`--status`, `--audience`, `--out`). |
|
|
62
|
+
| `coss audiences list`, `coss audiences get <audience>`, `coss audiences create <name>`, `coss audiences update <audience>`, `coss audiences remove <audience>` | [Static lists of contacts](https://coss.com/docs/email/audiences-and-segments). |
|
|
63
|
+
| `coss audiences contacts list <audience>`, `coss audiences contacts add <audience> <contact>...`, `coss audiences contacts remove <audience> <contact>` | Who is in an audience, by id or address (`add` exits 1 when one is no contact). |
|
|
64
|
+
| `coss segments list`, `coss segments get <segment>`, `coss segments create <name> --filter <json>`, `coss segments update <segment>`, `coss segments remove <segment>`, `coss segments contacts list <segment>` | Filters over the contacts, and who they match now. |
|
|
65
|
+
| `coss topics list`, `coss topics get <topic>`, `coss topics create <key>`, `coss topics update <topic>`, `coss topics remove <topic>` | [What contacts subscribe to](https://coss.com/docs/email/topics-and-preferences) (`--name`, `--default opt_in\|opt_out`, `--description`, `--visibility`, `--position`). |
|
|
66
|
+
| `coss marketing settings get`, `coss marketing settings set` | The sender's name, postal address and double opt-in (`--display-name`, `--mailing-address`, `--double-opt-in`, `--no-double-opt-in`, `--confirmation-from`, `--confirmation-subject`, `--confirmation-html`, `--confirmation-text`, `--confirmed-redirect-url`). |
|
|
67
|
+
| `coss broadcasts list`, `coss broadcasts get <broadcast>`, `coss broadcasts create`, `coss broadcasts update <broadcast>`, `coss broadcasts remove <broadcast>`, `coss broadcasts test <broadcast>`, `coss broadcasts send <broadcast>`, `coss broadcasts pause <broadcast>`, `coss broadcasts resume <broadcast>`, `coss broadcasts cancel <broadcast>` | [Marketing sends](https://coss.com/docs/email/broadcasts): `create` makes a draft from files, `send` and `resume` ask before a live send (`--yes` off a terminal, `--at` to schedule). |
|
|
68
|
+
| `coss sign upload <file.pdf>`, `coss sign create`, `coss sign send <request>` | [Signatures](https://coss.com/docs/sign): a PDF, a draft request (`--document` or `--template`, `--signer "Name <email>"`) and sending it. |
|
|
69
|
+
| `coss sign list`, `coss sign get <request>`, `coss sign remind <request>`, `coss sign cancel <request>`, `coss sign download <request>`, `coss sign audit <request>`, `coss sign templates`, `coss sign templates list` | Requests, reminders, the sealed PDF, the audit trail and templates. |
|
|
70
|
+
| `coss sign templates create <name>`, `coss sign settings get`, `coss sign settings set` | A new template (`--document`, `--role key:Name`, `--signing-order`, `--data` for its fields), and the name signers see, the sender, branding, reminders and embedding origins. |
|
|
71
|
+
| `coss sign diagnose <request>` | Where a request stands: each signer's state, whose turn it is, and what to do next. |
|
|
50
72
|
| `coss logs tail` | New lines of the environment's log as they arrive: API requests, email events, webhook attempts. Filter with `--source`, `--level`, `--type`, `--status`, `-q`; `--since 15m` starts earlier; `--interval` sets the poll interval (2000 ms). |
|
|
73
|
+
| `coss log-drains list`, `coss log-drains get <drain>`, `coss log-drains create <url>`, `coss log-drains update <drain>`, `coss log-drains delete <drain>` | [Log drains](https://coss.com/docs/log-drains): where the log is streamed (`--source`, `--format`, `--description`; `create` prints the signing secret once; `update` takes `--enabled`, `--disabled`, `--url`). `--auth-header <name>` takes the header's value from stdin or a prompt, never a flag; `--remove-auth-header` drops it. |
|
|
51
74
|
| `coss inbox` | The environment's inbound domain, then each email it receives as it arrives (`--since`, `--interval`). |
|
|
52
75
|
| `coss inbox get <id>` | A received email: verdicts, attachments and its text (`--html`, `--headers`); `--raw > message.eml` saves the message as received. |
|
|
53
76
|
| `coss inboxes list`, `coss inboxes create` | [Inboxes](https://coss.com/docs/inboxes): email addresses for agents (`--username`, `--domain`, `--name`, `--client-id`). |
|
|
@@ -65,11 +88,24 @@ ID and notarized by Apple (since 0.3.0), so one downloaded with a browser runs w
|
|
|
65
88
|
| `coss hooks send <app> <event-type>` | Sends a message: the payload from `--data '{…}'`, `-F name=value` fields, or the type's first example. |
|
|
66
89
|
| `coss hooks deliveries <app>`, `coss hooks attempts <app> <delivery>`, `coss hooks retry <app> <delivery>` | Deliveries (`--endpoint`, `--message`, `--status`), each HTTP request of one, and one more attempt. |
|
|
67
90
|
| `coss hooks portal <app>` | A portal link for the application's users (`--open`, `--read-only`, `--expires-in`). |
|
|
91
|
+
| `coss hooks diagnose <app> <delivery>` | What the endpoint answered on each attempt, the next retry, and whether it's disabled (or `--message`, `--endpoint`). |
|
|
68
92
|
| `coss risk assess --event <event>` | Assesses an event (`--email`, `--ip`, `--user`, `--content`, `--data '{…}'`…) and prints the decision, score and reasons. Sandbox fixtures (`192.0.2.1`, `disposable.test`, `[coss-test:spam]`…) produce each decision. |
|
|
69
93
|
| `coss risk assessments`, `coss risk feedback <assessment> --outcome <outcome>` | Assessments (`--review open`: the review queue), and what a user turned out to be. |
|
|
70
94
|
| `coss risk lists list`, `coss risk lists add <allow\|block> <type> <value>`, `coss risk lists remove <entry>` | The allow and block lists (`--note`, `--expires 7d`). |
|
|
71
|
-
| `coss
|
|
72
|
-
| `coss
|
|
95
|
+
| `coss risk rules list`, `coss risk rules get <rule>`, `coss risk rules create <name>`, `coss risk rules update <rule>`, `coss risk rules delete <rule>` | [Rules](https://coss.com/docs/risk/rules): `--action block --condition "ip.tor is true"` (`--match`, `--event`, `--position`, `--enabled`, `--disabled`, `--data`). |
|
|
96
|
+
| `coss risk check email <address>`, `coss risk check ip <ip>`, `coss risk check phone <number>`, `coss risk classify <text>` | [The signals on their own](https://coss.com/docs/risk/lookups); nothing is stored, and live phone checks are billed. `classify` also takes `--file` or `-`. |
|
|
97
|
+
| `coss risk settings get`, `coss risk settings set` | Thresholds, disabled reasons and the captcha (`--review-threshold`, `--block-threshold`, `--disabled-reason`, `--captcha`, `--captcha-required`, `--captcha-optional`, `--data`). `--captcha-secret-stdin` takes its secret from stdin or a prompt, never a flag. |
|
|
98
|
+
| `coss scheduling hosts`, `coss scheduling hosts list`, `coss scheduling bookings`, `coss scheduling event-types`, `coss scheduling event-types list` | The environment's [hosts, bookings and event types](https://coss.com/docs/scheduling). |
|
|
99
|
+
| `coss scheduling hosts create <name>`, `coss scheduling hosts update <host>`, `coss scheduling hosts remove <host>` | Who can be booked (`--time-zone`, `--uid`, `--email`, `--attribute`, `--metadata`, `--status`, `--data`). |
|
|
100
|
+
| `coss scheduling schedules list <host>`, `coss scheduling schedules create <host>`, `coss scheduling schedules update <host> <schedule>`, `coss scheduling schedules remove <host> <schedule>` | When a host is free: `--rule "mon-fri 09:00-17:00"` (`--name`, `--time-zone`, `--default`, `--data` for overrides). |
|
|
101
|
+
| `coss scheduling event-types create <title>`, `coss scheduling event-types update <event-type>` | What can be booked (`--minutes`, `--uid`, `--host`, `--kind`, `--status`, `--requires-approval`, `--no-approval`, `--data`). |
|
|
102
|
+
| `coss scheduling slots <event-type>`, `coss scheduling slots explain <event-type>`, `coss scheduling booking <booking>`, `coss scheduling booking-events <booking>`, `coss scheduling cancel <booking>`, `coss scheduling calendars <host>` | Bookable starts (`--start`, `--end`), one booking, cancelling it, and a host's calendar connections. |
|
|
103
|
+
| `coss scheduling reminders`, `coss scheduling notifications <booking>`, `coss scheduling no-show <booking>` | What goes out around a booking (`--event-type`), what was queued for one and why anything wasn't sent, and marking it a no-show. |
|
|
104
|
+
| `coss scheduling diagnose <event-type>` | Why there are no slots, each finding certain, likely or possible (`--start`, `--end`, `--host`). |
|
|
105
|
+
| `coss scheduling book <event-type>`, `coss scheduling reschedule <booking>`, `coss scheduling approve <booking>`, `coss scheduling decline <booking>` | Books a slot (`--start`, `--time-zone`, `--name`, `--email`, `--phone`, `--uid`, `--host`, `--minutes`, `--attribute`, `--answer`, `--metadata`, `--data`) and moves or decides one. They tell the attendee, so a live key asks first (`--yes` off a terminal). |
|
|
106
|
+
| `coss forms list`, `coss forms get <form>`, `coss forms create <name>`, `coss forms update <form>`, `coss forms remove <form>` | The environment's [forms](https://coss.com/docs/forms) and their endpoints (`update`: `--name`, `--enabled`, `--disabled`, `--origin`, `--redirect`, `--data`). `remove` can't be undone, so a live key asks first (`--yes` off a terminal). |
|
|
107
|
+
| `coss forms submissions <form>`, `coss forms submission <form> <submission>`, `coss forms release <form> <submission>` | A form's submissions (`--status held`: Risk's review queue), one's values, and accepting a held one. |
|
|
108
|
+
| `coss forms diagnose <form> [submission]` | What happened to a submission (the newest without an id): held, spam and why, waiting to be confirmed, or accepted and where it goes. |
|
|
73
109
|
| `coss domains list` | The organization's sending domains and their status. |
|
|
74
110
|
| `coss domains add <domain>` | Adds a domain and prints the DNS records to publish (`--format bind` prints zone-file lines). |
|
|
75
111
|
| `coss domains get <domain>` | A domain's records and what the last DNS check saw (verified, missing, mismatch). `--format bind` too. |
|
|
@@ -78,7 +114,7 @@ ID and notarized by Apple (since 0.3.0), so one downloaded with a browser runs w
|
|
|
78
114
|
| `coss templates pull [<template>...]` | Writes drafts to `--dir` (`templates`): a folder per template with `template.json` and `<locale>.subject.txt`, `<locale>.html`, `<locale>.txt`. |
|
|
79
115
|
| `coss templates push [<path>...]` | Saves drafts from those files, finding templates by alias (creating missing ones); `--publish` publishes after, `--watch` pushes again whenever a file changes. |
|
|
80
116
|
| `coss templates preview <template>` | Renders the draft (or `--version`) without sending: `--var name=value`, `--locale`, `--open` shows the HTML, `--output` saves it. |
|
|
81
|
-
| `coss api <path>` | Any endpoint of the API, with the CLI's key: `coss api domains`, `coss api -X POST domains/<id>/verify`. `-f name=value` (strings) and `-F name=value` (JSON values, `@file`) are query parameters for GET and DELETE and the JSON body otherwise; `--input file.json` (or `-` for stdin) sends a body as is; `--paginate` prints every item of a list; `--raw` prints a body that isn't JSON. |
|
|
117
|
+
| `coss api <path>` | Any endpoint of the API, including those without a command, with the CLI's key: `coss api domains`, `coss api -X POST domains/<id>/verify`. `-f name=value` (strings) and `-F name=value` (JSON values, `@file`) are query parameters for GET and DELETE and the JSON body otherwise; `--input file.json` (or `-` for stdin) sends a body as is; `--paginate` prints every item of a list; `--raw` prints a body that isn't JSON. |
|
|
82
118
|
| `coss completion <shell>` | The completion script for `bash`, `zsh` or `fish`, e.g. `eval "$(coss completion zsh)"` in `~/.zshrc`. |
|
|
83
119
|
|
|
84
120
|
Every command takes `--json` (one JSON object per line), `--profile <name>` and `--help`; `coss --version`
|
package/dist/cli.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
#!/usr/bin/env node
|
|
2
|
-
import { c as flushOutput, l as nodeIo, n as run } from "./run-
|
|
2
|
+
import { c as flushOutput, l as nodeIo, n as run } from "./run-kad9znCz.js";
|
|
3
3
|
//#region src/cli.ts
|
|
4
4
|
process.exitCode = await run(process.argv.slice(2), nodeIo());
|
|
5
5
|
await flushOutput();
|
package/dist/index.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export { u as CURSOR_FIELDS, t as HELP, r as VERSION, s as defaultConfigDir, i as generateSecret, l as nodeIo, n as run, a as sign, o as signatureHeaders } from "./run-
|
|
1
|
+
export { u as CURSOR_FIELDS, t as HELP, r as VERSION, s as defaultConfigDir, i as generateSecret, l as nodeIo, n as run, a as sign, o as signatureHeaders } from "./run-kad9znCz.js";
|