@arcsend/cli 1.0.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 +69 -0
- package/dist/index.js +2105 -0
- package/package.json +44 -0
package/README.md
ADDED
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
# ArcSend CLI
|
|
2
|
+
|
|
3
|
+
Cold email automation from your terminal. Drive campaigns, accounts, leads, inbox, warmup, and deliverability directly — or from scripts and agents.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm i -g @arcsend/cli # global: `arcsend ...`
|
|
9
|
+
# or, no install:
|
|
10
|
+
npx @arcsend/cli --help
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Setup
|
|
14
|
+
|
|
15
|
+
Get an API key from your ArcSend workspace (Settings → API Keys), then:
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
arcsend auth setup --key arc_xxxxxxxx
|
|
19
|
+
# dedicated instance? point at your domain:
|
|
20
|
+
arcsend auth setup --key arc_xxxxxxxx --url https://send.yourdomain.com
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
Or use env vars: `ARCSEND_API_KEY`, `ARCSEND_URL`.
|
|
24
|
+
|
|
25
|
+
## Basics
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
arcsend campaigns list # human table (default)
|
|
29
|
+
arcsend campaigns list -j # raw JSON (for scripts/pipes)
|
|
30
|
+
arcsend campaigns list --csv # CSV (Excel/Sheets)
|
|
31
|
+
arcsend campaigns list --fields name,status,sent
|
|
32
|
+
arcsend campaigns activate <id> --dry-run # preview a change, do nothing
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
- `-j` JSON, `--csv` CSV, `--fields a,b,c` pick columns — work before **or** after the command.
|
|
36
|
+
- `--dry-run` previews any create/update/delete/activate/send without executing it.
|
|
37
|
+
- `--api-key` / `--url` override auth for a single command.
|
|
38
|
+
|
|
39
|
+
Run `arcsend --help` or `arcsend <group> --help` for the full command list.
|
|
40
|
+
|
|
41
|
+
## Scope
|
|
42
|
+
|
|
43
|
+
A key is scoped to one workspace — exactly like the API. The CLI only ever touches that workspace.
|
|
44
|
+
|
|
45
|
+
## Agent skills
|
|
46
|
+
|
|
47
|
+
The CLI is agent-native. `skills/` holds task playbooks an AI assistant can load to operate ArcSend, each grounded in how the product actually works:
|
|
48
|
+
|
|
49
|
+
| Skill | Covers |
|
|
50
|
+
|---|---|
|
|
51
|
+
| `arcsend-outbound-prep` | **Meta workflow** — warm accounts → suppress → create → sequence → leads → preflight → launch → monitor |
|
|
52
|
+
| `arcsend-campaigns` | Campaign lifecycle, preflight, accounts, reports |
|
|
53
|
+
| `arcsend-sequences` | Steps, delays, spintax/variables, A/B variants |
|
|
54
|
+
| `arcsend-accounts` | Inspect/edit mailboxes (connect is app-only), health, DNS |
|
|
55
|
+
| `arcsend-warmup` | Warmup, hard caps, readiness |
|
|
56
|
+
| `arcsend-leads` | Add/import/track contacts |
|
|
57
|
+
| `arcsend-inbox` | Replies, sentiment vs lead status, AI drafts |
|
|
58
|
+
| `arcsend-ai` | Configure the AI reply agent (tone, instructions) |
|
|
59
|
+
| `arcsend-deliverability` | Bounces, domain/account health, scans |
|
|
60
|
+
| `arcsend-blacklist` | Do-not-contact suppression |
|
|
61
|
+
| `arcsend-templates` | Save/apply reusable sequences |
|
|
62
|
+
| `arcsend-webhooks` | Real-time event subscriptions |
|
|
63
|
+
|
|
64
|
+
Agent context for the whole CLI lives in [`AGENTS.md`](./AGENTS.md); build/architecture notes in [`CLAUDE.md`](./CLAUDE.md).
|
|
65
|
+
|
|
66
|
+
## Safety & validation
|
|
67
|
+
|
|
68
|
+
- `--dry-run` previews any change without executing it.
|
|
69
|
+
- Input is validated client-side against ArcSend's real rules (step 1 needs a subject, every step a body, `daily_limit` 1–50, warmup caps, AI temperature 0–1) — bad input fails instantly with a readable message instead of a server round-trip.
|