@zerodeploy/cli 0.1.1 → 0.1.3

package/README.md

@@ -24,7 +24,7 @@ zerodeploy login
 zerodeploy org create "My Company"
 
 # 3. Create a site
-zerodeploy site create my-company "My Website" --subdomain my-website
+zerodeploy site create my-company "My Website"
 
 # 4. Deploy your site
 zerodeploy deploy my-website --org my-company --dir ./dist
@@ -60,6 +60,17 @@ Display current logged-in user information.
 zerodeploy whoami
 ```
 
+#### `zerodeploy usage`
+
+Display current usage and plan limits with visual progress bars.
+
+```bash
+zerodeploy usage
+```
+
+**Options:**
+- `--json` - Output as JSON for scripting
+
 ### Organizations
 
 #### `zerodeploy org list`
@@ -96,44 +107,93 @@ List all sites in an organization.
 zerodeploy site list my-company
 ```
 
-#### `zerodeploy site create <orgSlug> <name> --subdomain <subdomain>`
+#### `zerodeploy site create <orgSlug> <name>`
 
-Create a new site in an organization.
+Create a new site in an organization. The subdomain is auto-generated from the name.
 
 **Options:**
-- `--subdomain <subdomain>` - Subdomain for the site (required, globally unique)
 - `--repo <owner/repo>` - Link to a GitHub repository
 
 ```bash
 # Create a site
-zerodeploy site create my-company "My Website" --subdomain my-website
+zerodeploy site create my-company "My Website"
 
 # Create a site linked to a GitHub repo
-zerodeploy site create my-company "Dashboard" --subdomain dashboard --repo company/monorepo
+zerodeploy site create my-company "Dashboard" --repo company/monorepo
 ```
 
 Your site will be available at `https://<subdomain>.zerodeploy.app`
 
+#### `zerodeploy site rename <siteSlug> <newName> --org <orgSlug>`
+
+Rename a site's display name.
+
+```bash
+zerodeploy site rename my-website "New Website Name" --org my-company
+```
+
+Note: This changes the display name, not the slug or subdomain.
+
+#### `zerodeploy site link <orgSlug> <siteSlug> <repo>`
+
+Link a site to a GitHub repository.
+
+```bash
+zerodeploy site link my-company dashboard company/monorepo
+```
+
+#### `zerodeploy site unlink <orgSlug> <siteSlug>`
+
+Remove the GitHub repository link from a site.
+
+```bash
+zerodeploy site unlink my-company dashboard
+```
+
+#### `zerodeploy site subdomain <orgSlug> <siteSlug> <subdomain>`
+
+Update the subdomain for a site.
+
+```bash
+zerodeploy site subdomain my-company my-website new-subdomain
+```
+
+After updating, your site will be accessible at `https://new-subdomain.zerodeploy.app`.
+
 #### `zerodeploy site delete <siteSlug> --org <orgSlug>`
 
 Delete a site and all its deployments.
 
+**Options:**
+- `--force` - Skip confirmation prompt
+
 ```bash
 zerodeploy site delete my-website --org my-company
 ```
 
 ### Deployment
 
-#### `zerodeploy deploy <siteSlug> [options]`
+#### `zerodeploy deploy [siteSlug] [options]`
 
-Deploy a directory to a site.
+Deploy a directory to a site. If using a `zerodeploy.json` config file, site and org can be omitted.
 
 **Options:**
-- `--org <orgSlug>` - Organization slug (required)
+- `--org <orgSlug>` - Organization slug (required, or from config)
 - `--dir <directory>` - Directory to deploy (default: auto-detect)
 - `--build` - Run build command before deploying
+- `--no-build` - Skip build step
 - `--build-command <cmd>` - Custom build command
 - `--install` - Run install command before building
+- `--preview` - Deploy without setting as current (preview only)
+- `--no-verify` - Skip deployment verification
+- `--no-auto-rollback` - Disable automatic rollback on verification failure
+
+**CI/CD Options:**
+- `--pr <number>` - PR number
+- `--pr-title <title>` - PR title
+- `--commit <sha>` - Commit SHA
+- `--branch <branch>` - Branch name
+- `--github-output` - Output deployment info in GitHub Actions format
 
 ```bash
 # Deploy specific directory
@@ -147,18 +207,34 @@ zerodeploy deploy my-website --org my-company --build
 
 # Install dependencies, build, and deploy
 zerodeploy deploy my-website --org my-company --install --build
+
+# Deploy as preview (doesn't go live)
+zerodeploy deploy my-website --org my-company --preview
 ```
 
 Output:
 ```
 Deploying: ./dist
 Found 42 files (1.2 MB)
-Uploading files...
-  [100%] 42/42 files
+Uploading...
+Finalizing...
+Verifying...
 
 Deployment successful!
-URL:     https://my-website.zerodeploy.app
-Preview: https://019b1234-my-website.zerodeploy.app
+URL:     https://my-website.zerodeploy.app (verified)
+Preview: https://abc12345-my-website.zerodeploy.app
+```
+
+#### `zerodeploy deploy promote <deploymentId>`
+
+Promote a preview deployment to production.
+
+```bash
+# Promote using short ID (first 8 chars)
+zerodeploy deploy promote abc12345
+
+# Or use full deployment ID
+zerodeploy deploy promote 019b1234-5678-90ab-cdef-1234567890ab
 ```
 
 #### `zerodeploy deployments list <siteSlug> --org <orgSlug>`
@@ -214,6 +290,145 @@ Delete a deploy token.
 zerodeploy token delete 019b1234 --org my-company --site my-website
 ```
 
+### Custom Domains
+
+Connect your own domain to any ZeroDeploy site with automatic SSL.
+
+#### `zerodeploy domain add <domain> --org <org> --site <site>`
+
+Add a custom domain to a site. Returns DNS verification instructions.
+
+```bash
+zerodeploy domain add www.example.com --org my-company --site my-website
+```
+
+#### `zerodeploy domain verify <domain> --org <org> --site <site>`
+
+Verify domain ownership after adding the TXT record to your DNS.
+
+```bash
+zerodeploy domain verify www.example.com --org my-company --site my-website
+```
+
+#### `zerodeploy domain list --org <org> --site <site>`
+
+List all custom domains for a site.
+
+```bash
+zerodeploy domain list --org my-company --site my-website
+```
+
+#### `zerodeploy domain remove <domain> --org <org> --site <site>`
+
+Remove a custom domain from a site.
+
+```bash
+zerodeploy domain remove www.example.com --org my-company --site my-website
+```
+
+#### `zerodeploy domain redirect <domain> --org <org> --site <site> --mode <mode>`
+
+Set redirect mode for a custom domain. This allows automatic redirects between www and apex (non-www) domains.
+
+**Options:**
+- `--mode <mode>` - Redirect mode: `none`, `www_to_apex`, or `apex_to_www`
+
+```bash
+# Redirect www.example.com to example.com
+zerodeploy domain redirect example.com --org my-company --site my-website --mode www_to_apex
+
+# Redirect example.com to www.example.com
+zerodeploy domain redirect www.example.com --org my-company --site my-website --mode apex_to_www
+
+# Disable redirects
+zerodeploy domain redirect example.com --org my-company --site my-website --mode none
+```
+
+**Custom Domain Setup:**
+
+1. Add the domain: `zerodeploy domain add www.example.com --org my-org --site my-site`
+2. Add the TXT record to your DNS (shown in output)
+3. Verify ownership: `zerodeploy domain verify www.example.com --org my-org --site my-site`
+4. Add the CNAME record to your DNS (shown in output)
+5. Your site is now live at `https://www.example.com`
+
+### Forms
+
+Collect form submissions from your static sites without a backend. Get email notifications when forms are submitted.
+
+#### `zerodeploy form list --org <org> --site <site>`
+
+List all forms for a site with submission counts.
+
+```bash
+zerodeploy form list --org my-company --site my-website
+```
+
+#### `zerodeploy form export <name> --org <org> --site <site>`
+
+Export form submissions as CSV.
+
+**Options:**
+- `-o, --output <file>` - Output file path (default: `<name>-submissions.csv`)
+
+```bash
+# Export to default file
+zerodeploy form export contact --org my-company --site my-website
+
+# Export to custom file
+zerodeploy form export contact --org my-company --site my-website -o leads.csv
+```
+
+#### `zerodeploy form delete <name> --org <org> --site <site>`
+
+Delete a form and all its submissions.
+
+**Options:**
+- `--force` - Skip confirmation prompt
+
+```bash
+zerodeploy form delete contact --org my-company --site my-website
+```
+
+#### `zerodeploy form notify <name> --org <org> --site <site>`
+
+Configure email notifications for form submissions.
+
+**Options:**
+- `--email <email>` - Email address to receive notifications
+- `--disable` - Disable email notifications
+
+```bash
+# Enable notifications
+zerodeploy form notify contact --org my-company --site my-website --email alerts@example.com
+
+# Disable notifications
+zerodeploy form notify contact --org my-company --site my-website --disable
+```
+
+### Account
+
+#### `zerodeploy account email <email>`
+
+Set or update your email address for deployment notifications.
+
+```bash
+zerodeploy account email you@example.com
+```
+
+#### `zerodeploy account delete`
+
+Permanently delete your account and all associated data.
+
+**Options:**
+- `--force` - Skip confirmation prompts
+
+```bash
+zerodeploy account delete
+```
+
+**Warning:** This permanently deletes your account, all organizations, sites, deployments, and custom domains.
+
 ## Configuration File
 
 Create a `zerodeploy.json` in your project root:
@@ -222,21 +437,36 @@ Create a `zerodeploy.json` in your project root:
 zerodeploy init --org my-company --site my-website
 ```
 
-This creates:
+The CLI auto-detects your framework and creates an appropriate config:
 
 ```json
 {
   "org": "my-company",
-  "site": "my-website"
+  "site": "my-website",
+  "dir": "dist",
+  "build": "npm run build"
 }
 ```
 
+**Config Options:**
+
+| Field | Description |
+|-------|-------------|
+| `org` | Organization slug |
+| `site` | Site slug |
+| `dir` | Build output directory |
+| `build` | Build command (used with `--build` flag) |
+| `install` | Install command (used with `--install` flag) |
+
 Then deploy with just:
 
 ```bash
-zerodeploy deploy
+zerodeploy deploy           # deploy only
+zerodeploy deploy --build   # build + deploy
 ```
 
+CLI flags always take precedence over config values.
+
 ## Deployed Sites
 
 ### URLs