create-mailslot 0.2.0 → 0.2.1
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 +20 -20
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
# create-mailslot
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
inbox for AI agents — to your own Cloudflare account, interactively.
|
|
3
|
+
> A real inbox for AI agents. Self-hosted.
|
|
5
4
|
|
|
6
|
-
|
|
5
|
+
Deploy [Mailslot](https://github.com/mailslot/mailslot) to your own Cloudflare
|
|
6
|
+
account, interactively.
|
|
7
7
|
|
|
8
8
|
```sh
|
|
9
9
|
npx create-mailslot
|
|
@@ -11,29 +11,29 @@ npx create-mailslot
|
|
|
11
11
|
|
|
12
12
|
The wizard:
|
|
13
13
|
|
|
14
|
-
1. **Scaffolds a project you own
|
|
15
|
-
|
|
16
|
-
2. **Guards your existing mail
|
|
17
|
-
|
|
18
|
-
truth: Email Routing is zone-level, so that domain
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
3. **Provisions everything
|
|
22
|
-
worker deploy with your domain baked in
|
|
23
|
-
4. **Sets up Email Routing
|
|
24
|
-
(`Zone → Email Routing Rules → Edit`), or guided dashboard steps with
|
|
25
|
-
|
|
26
|
-
5. **Proves it works
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
## Flags (all optional
|
|
14
|
+
1. **Scaffolds a project you own.** A thin worker depending on `@mailslot/core`,
|
|
15
|
+
deployed from your machine with wrangler.
|
|
16
|
+
2. **Guards your existing mail.** If the domain's apex already receives mail
|
|
17
|
+
elsewhere (Google Workspace, Lark, O365, and so on), the wizard tells you the
|
|
18
|
+
truth: Email Routing is zone-level, so that domain cannot host Mailslot, not
|
|
19
|
+
even on a subdomain, without breaking its mail. It steers you to a different
|
|
20
|
+
domain instead of letting you find out the hard way.
|
|
21
|
+
3. **Provisions everything.** R2 bucket, a generated API token (secret), and a
|
|
22
|
+
worker deploy with your domain baked in.
|
|
23
|
+
4. **Sets up Email Routing.** Fully automatic with a Cloudflare API token
|
|
24
|
+
(`Zone → Email Routing Rules → Edit`), or guided dashboard steps with live
|
|
25
|
+
DNS verification if you'd rather click.
|
|
26
|
+
5. **Proves it works.** Ends with a live round-trip: send an email from your
|
|
27
|
+
phone, watch it appear in your terminal.
|
|
28
|
+
|
|
29
|
+
## Flags (all optional, omitted values are prompted)
|
|
30
30
|
|
|
31
31
|
```
|
|
32
32
|
--dir <path> project directory (default: mailslot)
|
|
33
33
|
--domain <domain> email domain on Cloudflare (e.g. mail.example.com)
|
|
34
34
|
--worker-name <name> worker name (default: mailslot)
|
|
35
35
|
--cf-token <token> Cloudflare API token for Email Routing setup
|
|
36
|
-
--core-spec <spec> @mailslot/core version/spec (default:
|
|
36
|
+
--core-spec <spec> @mailslot/core version/spec (default: matches this wizard's version)
|
|
37
37
|
--skip-install / --skip-routing / --skip-test
|
|
38
38
|
```
|
|
39
39
|
|