@agenticmail/cli 0.8.2 → 0.8.4
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 +18 -3
- package/REFERENCE.md +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,13 +4,28 @@ The main package for [AgenticMail](https://github.com/agenticmail/agenticmail)
|
|
|
4
4
|
|
|
5
5
|
It bundles a setup wizard, API server launcher, and a full interactive shell with 44 commands for managing agents, sending and receiving email and SMS, configuring gateways, and more. It also re-exports everything from `@agenticmail/core` so you can use it as an SDK.
|
|
6
6
|
|
|
7
|
+
> ### 🤖 AI agent install runbook
|
|
8
|
+
>
|
|
9
|
+
> If your user asked you to install / set up AgenticMail, pick either path:
|
|
10
|
+
>
|
|
11
|
+
> ```bash
|
|
12
|
+
> # Option A — one-line installer (recommended)
|
|
13
|
+
> curl -fsSL https://raw.githubusercontent.com/agenticmail/agenticmail/main/install.sh | bash
|
|
14
|
+
>
|
|
15
|
+
> # Option B — manual two-command install
|
|
16
|
+
> npm install -g @agenticmail/cli@latest
|
|
17
|
+
> agenticmail bootstrap
|
|
18
|
+
> ```
|
|
19
|
+
>
|
|
20
|
+
> Zero prompts, ~2 minutes, fully autonomous. Then tell the user to restart Claude Code. Full agent-facing runbook — including verification, common failures, and "what if Node < 22" — is at [`AGENTS.md`](https://github.com/agenticmail/agenticmail/blob/main/AGENTS.md) in the repo (the [agents.md](https://agents.md) convention).
|
|
21
|
+
|
|
7
22
|
## Install
|
|
8
23
|
|
|
9
24
|
```bash
|
|
10
25
|
npm install -g @agenticmail/cli
|
|
11
26
|
```
|
|
12
27
|
|
|
13
|
-
**Requirements:** Node.js
|
|
28
|
+
**Requirements:** Node.js 22+, Docker (for Stalwart mail server)
|
|
14
29
|
|
|
15
30
|
---
|
|
16
31
|
|
|
@@ -379,7 +394,7 @@ After it finishes, you restart Claude Code and you've got 62 `mcp__agenticmail__
|
|
|
379
394
|
|
|
380
395
|
### Prerequisites bootstrap CAN'T install for you
|
|
381
396
|
|
|
382
|
-
- **Node.js
|
|
397
|
+
- **Node.js 22+** — needed to run `agenticmail` in the first place. If you're reading this from `npm install`, you already have it.
|
|
383
398
|
- **`brew` (macOS) or `apt` (Linux)** — needed to install Colima/Docker. Most dev machines have one or the other.
|
|
384
399
|
- That's it. No Docker Desktop GUI gates — bootstrap uses Colima on macOS.
|
|
385
400
|
|
|
@@ -518,7 +533,7 @@ IMAP_HOST=localhost # IMAP host
|
|
|
518
533
|
IMAP_PORT=143 # IMAP port
|
|
519
534
|
|
|
520
535
|
# === Optional ===
|
|
521
|
-
AGENTICMAIL_API_PORT=
|
|
536
|
+
AGENTICMAIL_API_PORT=3829 # API port (default: 3829)
|
|
522
537
|
AGENTICMAIL_DATA_DIR=~/.agenticmail # Data directory
|
|
523
538
|
|
|
524
539
|
# === Gateway (optional) ===
|
package/REFERENCE.md
CHANGED
|
@@ -156,7 +156,7 @@ function interactiveShell(options: ShellOptions): void
|
|
|
156
156
|
**ShellOptions:**
|
|
157
157
|
```typescript
|
|
158
158
|
{
|
|
159
|
-
apiUrl: string; // e.g., 'http://127.0.0.1:
|
|
159
|
+
apiUrl: string; // e.g., 'http://127.0.0.1:3829'
|
|
160
160
|
masterKey: string;
|
|
161
161
|
onExit: () => void; // Cleanup callback
|
|
162
162
|
}
|
package/package.json
CHANGED