Skip to content

DreamsHive/cloakmail-cli

Repository files navigation

cloakmail-cli

The official CLI for deploying CloakMail to Cloudflare.

npm License


Usage

Zero-install — run directly with bunx from any directory on your machine:

bunx cloakmail-cli setup

Or install it globally:

bun install -g cloakmail-cli
cloakmail-cli setup

Commands

cloakmail-cli setup     # Deploy CloakMail to your Cloudflare account end-to-end
cloakmail-cli destroy   # Tear down a previous deployment
cloakmail-cli --help    # Show all available flags and options

setup walks you through the entire deployment: Cloudflare API token, email zone, web hostname, then provisions D1 and R2, deploys both Workers, configures Email Routing, binds your custom domain, and verifies the whole thing.

destroy cleans up every resource the wizard created — workers, D1 database, R2 bucket, catch-all rule, custom domain — with a confirmation prompt.

Documentation

For full setup guides, API reference, and deployment instructions, visit the official documentation at docs.cloakmail.dev.

License

This project is licensed under the MIT License.

About

Official CloakMail CLI

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors