agenticmail 0.5.1 → 0.5.2
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 +61 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -76,6 +76,66 @@ Agent emails use proper addresses like `secretary@yourdomain.com`.
|
|
|
76
76
|
|
|
77
77
|
---
|
|
78
78
|
|
|
79
|
+
## CLI Commands
|
|
80
|
+
|
|
81
|
+
All commands are available via `agenticmail <command>` or `npx agenticmail@latest <command>`.
|
|
82
|
+
|
|
83
|
+
### Core Commands
|
|
84
|
+
|
|
85
|
+
| Command | Description |
|
|
86
|
+
|---------|-------------|
|
|
87
|
+
| `agenticmail` | **Start the server.** Runs setup first if not initialized, then starts all services and opens the interactive shell. This is the default — just run `agenticmail` with no arguments. |
|
|
88
|
+
| `agenticmail setup` | **Run the setup wizard.** Walks you through system checks, account creation, service startup, email connection, phone number setup, and OpenClaw integration. Safe to re-run anytime. |
|
|
89
|
+
| `agenticmail start` | **Start the server and open the interactive shell.** Ensures Docker is running, Stalwart is up, and the API server is reachable. Automatically installs the auto-start service. |
|
|
90
|
+
| `agenticmail stop` | **Stop the server.** Kills the background API server process. If auto-start is enabled, it will restart on next boot. |
|
|
91
|
+
| `agenticmail status` | **Show what's running.** Displays Docker, Stalwart, API server, email connection, and auto-start service status. |
|
|
92
|
+
|
|
93
|
+
### Integration Commands
|
|
94
|
+
|
|
95
|
+
| Command | Description |
|
|
96
|
+
|---------|-------------|
|
|
97
|
+
| `agenticmail openclaw` | **Set up AgenticMail for OpenClaw.** Starts infrastructure, creates an agent, configures the plugin, enables agent auto-spawn via hooks, and restarts the OpenClaw gateway. |
|
|
98
|
+
|
|
99
|
+
### Service Management (Auto-Start on Boot)
|
|
100
|
+
|
|
101
|
+
AgenticMail installs a system service so your email server starts automatically when your computer boots — no manual intervention needed.
|
|
102
|
+
|
|
103
|
+
| Command | Description |
|
|
104
|
+
|---------|-------------|
|
|
105
|
+
| `agenticmail service` | **Show auto-start status.** Whether the service is installed and running. |
|
|
106
|
+
| `agenticmail service install` | **Install the auto-start service.** On boot, the startup script waits up to 10 minutes for Docker, checks Stalwart (starts it if needed), then launches the API server. |
|
|
107
|
+
| `agenticmail service uninstall` | **Remove the auto-start service.** AgenticMail will no longer start on boot. |
|
|
108
|
+
| `agenticmail service reinstall` | **Reinstall the service.** Use after config changes or updates to refresh the service file. |
|
|
109
|
+
|
|
110
|
+
**How auto-start works on reboot:**
|
|
111
|
+
1. Computer starts → Docker Desktop launches (its own auto-start)
|
|
112
|
+
2. Stalwart mail server starts (`restart: unless-stopped` in Docker)
|
|
113
|
+
3. AgenticMail startup script waits for Docker to be ready (up to 10 min)
|
|
114
|
+
4. Script verifies Stalwart is running (auto-starts it if needed)
|
|
115
|
+
5. API server starts and begins accepting requests
|
|
116
|
+
6. If the server crashes, the system service automatically restarts it
|
|
117
|
+
|
|
118
|
+
On macOS this uses a LaunchAgent (`~/Library/LaunchAgents/com.agenticmail.server.plist`). On Linux it uses a systemd user service (`~/.config/systemd/user/agenticmail.service`).
|
|
119
|
+
|
|
120
|
+
### Maintenance Commands
|
|
121
|
+
|
|
122
|
+
| Command | Description |
|
|
123
|
+
|---------|-------------|
|
|
124
|
+
| `agenticmail update` | **Update to the latest version.** Checks npm, updates the CLI and OpenClaw plugin, and restarts the gateway. |
|
|
125
|
+
| `agenticmail help` | **Show available commands.** |
|
|
126
|
+
|
|
127
|
+
### Logs
|
|
128
|
+
|
|
129
|
+
Server logs are stored in `~/.agenticmail/logs/`:
|
|
130
|
+
|
|
131
|
+
| File | Contents |
|
|
132
|
+
|------|----------|
|
|
133
|
+
| `server.log` | API server stdout |
|
|
134
|
+
| `server.err.log` | API server stderr |
|
|
135
|
+
| `startup.log` | Boot sequence log — Docker wait times, Stalwart checks, startup events |
|
|
136
|
+
|
|
137
|
+
---
|
|
138
|
+
|
|
79
139
|
## Starting the Server
|
|
80
140
|
|
|
81
141
|
`agenticmail start` does three things:
|
|
@@ -98,6 +158,7 @@ If the server crashes, you get clear error output showing what went wrong.
|
|
|
98
158
|
- **Account setup** — whether the config file and database exist
|
|
99
159
|
- **Server health** — API server connectivity and Stalwart reachability
|
|
100
160
|
- **Email gateway** — current mode (relay or domain), provider name, domain name, polling status
|
|
161
|
+
- **Auto-start** — whether the system service is installed and running
|
|
101
162
|
|
|
102
163
|
---
|
|
103
164
|
|