@agenticmail/cli 0.8.2 → 0.8.3
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 +14 -3
- package/REFERENCE.md +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,13 +4,24 @@ 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, run:
|
|
10
|
+
>
|
|
11
|
+
> ```bash
|
|
12
|
+
> npm install -g @agenticmail/cli@latest
|
|
13
|
+
> agenticmail bootstrap
|
|
14
|
+
> ```
|
|
15
|
+
>
|
|
16
|
+
> 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).
|
|
17
|
+
|
|
7
18
|
## Install
|
|
8
19
|
|
|
9
20
|
```bash
|
|
10
21
|
npm install -g @agenticmail/cli
|
|
11
22
|
```
|
|
12
23
|
|
|
13
|
-
**Requirements:** Node.js
|
|
24
|
+
**Requirements:** Node.js 22+, Docker (for Stalwart mail server)
|
|
14
25
|
|
|
15
26
|
---
|
|
16
27
|
|
|
@@ -379,7 +390,7 @@ After it finishes, you restart Claude Code and you've got 62 `mcp__agenticmail__
|
|
|
379
390
|
|
|
380
391
|
### Prerequisites bootstrap CAN'T install for you
|
|
381
392
|
|
|
382
|
-
- **Node.js
|
|
393
|
+
- **Node.js 22+** — needed to run `agenticmail` in the first place. If you're reading this from `npm install`, you already have it.
|
|
383
394
|
- **`brew` (macOS) or `apt` (Linux)** — needed to install Colima/Docker. Most dev machines have one or the other.
|
|
384
395
|
- That's it. No Docker Desktop GUI gates — bootstrap uses Colima on macOS.
|
|
385
396
|
|
|
@@ -518,7 +529,7 @@ IMAP_HOST=localhost # IMAP host
|
|
|
518
529
|
IMAP_PORT=143 # IMAP port
|
|
519
530
|
|
|
520
531
|
# === Optional ===
|
|
521
|
-
AGENTICMAIL_API_PORT=
|
|
532
|
+
AGENTICMAIL_API_PORT=3829 # API port (default: 3829)
|
|
522
533
|
AGENTICMAIL_DATA_DIR=~/.agenticmail # Data directory
|
|
523
534
|
|
|
524
535
|
# === 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