@zerodeploy/cli 0.1.0 → 0.1.1

package/README.md

@@ -1,18 +1,18 @@
 # ZeroDeploy CLI
 
-Command-line interface for deploying static sites to ZeroDeploy.
+Command-line interface for deploying static sites and SPAs to [ZeroDeploy](https://zerodeploy.dev).
 
 ## Installation
 
 ```bash
-# From the monorepo root
-bun install
-
-# Link CLI globally
-cd apps/cli && bun link
+npm install -g @zerodeploy/cli
 ```
 
-After linking, the `zerodeploy` command is available globally.
+Or use directly with npx:
+
+```bash
+npx @zerodeploy/cli deploy
+```
 
 ## Quick Start
 
@@ -24,26 +24,26 @@ zerodeploy login
 zerodeploy org create "My Company"
 
 # 3. Create a site
-zerodeploy site create my-company "My Website"
+zerodeploy site create my-company "My Website" --subdomain my-website
 
 # 4. Deploy your site
 zerodeploy deploy my-website --org my-company --dir ./dist
 ```
 
+Your site will be live at `https://my-website.zerodeploy.app`
+
 ## Commands
 
 ### Authentication
 
 #### `zerodeploy login`
 
-Authenticate with GitHub OAuth. Opens browser for authentication and stores JWT token locally.
+Authenticate with GitHub OAuth. Opens your browser for authentication.
 
 ```bash
 zerodeploy login
 ```
 
-Token is stored at `~/.zerodeploy/token`.
-
 #### `zerodeploy logout`
 
 Clear stored authentication token.
@@ -60,449 +60,335 @@ Display current logged-in user information.
 zerodeploy whoami
 ```
 
-Output:
-```
-Logged in as:
-  Username: johndoe
-  User ID:  019b1234-5678-...
-  Admin:    No
-```
-
 ### Organizations
 
 #### `zerodeploy org list`
 
-List all organizations you own.
+List all organizations you have access to.
 
 ```bash
 zerodeploy org list
 ```
 
-Output:
-```
-Organizations:
-- My Company [paid] (id: 019b1234-...)
-- Personal [paid] (id: 019b5678-...)
-```
-
 #### `zerodeploy org create <name>`
 
-Create a new organization. Slug is auto-generated from the name.
+Create a new organization.
 
 ```bash
 zerodeploy org create "My Company"
 ```
 
-Output:
-```
-Organization created: My Company
-  id: 019b1234-5678-...
+#### `zerodeploy org delete <orgSlug>`
+
+Delete an organization (must have no sites).
+
+```bash
+zerodeploy org delete my-company
 ```
 
 ### Sites
 
 #### `zerodeploy site list <orgSlug>`
 
-List all sites in an organization. Shows linked GitHub repositories if configured.
+List all sites in an organization.
 
 ```bash
 zerodeploy site list my-company
 ```
 
-Output:
-```
-Sites:
-  my-website           My Website -> company/frontend
-  landing-page         Landing Page
-  docs                 Documentation -> company/monorepo
-```
-
-#### `zerodeploy site create <orgSlug> <name> [options]`
+#### `zerodeploy site create <orgSlug> <name> --subdomain <subdomain>`
 
-Create a new site in an organization. Slug is auto-generated from the name.
+Create a new site in an organization.
 
 **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"
+zerodeploy site create my-company "My Website" --subdomain my-website
 
 # Create a site linked to a GitHub repo
-zerodeploy site create my-company "Dashboard" --repo company/monorepo
+zerodeploy site create my-company "Dashboard" --subdomain dashboard --repo company/monorepo
 ```
 
-Output:
-```
-Site created: Dashboard
-  ID: 019b1234-5678-...
-  Repo: company/monorepo
-```
-
-#### `zerodeploy site link <orgSlug> <siteSlug> <repo>`
-
-Link an existing site to a GitHub repository. One repository can be linked to multiple sites (monorepo support).
-
-```bash
-zerodeploy site link my-company dashboard company/monorepo
-```
-
-Output:
-```
-Site "Dashboard" linked to company/monorepo
-```
+Your site will be available at `https://<subdomain>.zerodeploy.app`
 
-#### `zerodeploy site unlink <orgSlug> <siteSlug>`
+#### `zerodeploy site delete <siteSlug> --org <orgSlug>`
 
-Remove the GitHub repository link from a site.
+Delete a site and all its deployments.
 
 ```bash
-zerodeploy site unlink my-company dashboard
-```
-
-Output:
-```
-Site "Dashboard" unlinked from GitHub repository
-```
-
-#### GitHub Repository Linking
-
-Sites can be linked to GitHub repositories to enable:
-- Tracking which repo deploys to which site
-- Future: Automatic PR preview comments
-- Future: GitHub webhook integration
-
-**Monorepo support:** One repository can be linked to multiple sites:
-
-```
-company/monorepo
-├── apps/marketing  → site: marketing
-├── apps/dashboard  → site: dashboard
-└── apps/docs       → site: docs
+zerodeploy site delete my-website --org my-company
 ```
 
 ### Deployment
 
 #### `zerodeploy deploy <siteSlug> [options]`
 
-Deploy a directory to a site. Uploads all files and makes the deployment live.
-
-**Arguments:**
-- `siteSlug` - The site slug to deploy to
+Deploy a directory to a site.
 
 **Options:**
 - `--org <orgSlug>` - Organization slug (required)
 - `--dir <directory>` - Directory to deploy (default: auto-detect)
 - `--build` - Run build command before deploying
-- `--no-build` - Skip build step (even if output dir doesn't exist)
-- `--build-command <cmd>` - Override the build command
+- `--build-command <cmd>` - Custom build command
 - `--install` - Run install command before building
 
-**CI/CD Options:**
-- `--pr <number>` - PR number (for GitHub Actions)
-- `--pr-title <title>` - PR title
-- `--commit <sha>` - Commit SHA
-- `--commit-message <message>` - Commit message
-- `--branch <branch>` - Branch name
-- `--github-output` - Output deployment info in GitHub Actions format
-
 ```bash
 # Deploy specific directory
 zerodeploy deploy my-website --org my-company --dir ./dist
 
-# Auto-detect build directory (looks for dist/, build/, out/, public/)
+# Auto-detect build directory
 zerodeploy deploy my-website --org my-company
 
-# Build and deploy (auto-detects framework)
+# Build and deploy
 zerodeploy deploy my-website --org my-company --build
 
-# Install, build, and deploy
+# Install dependencies, build, and deploy
 zerodeploy deploy my-website --org my-company --install --build
-
-# Custom build command
-zerodeploy deploy my-website --org my-company --build-command "npm run build:prod"
 ```
 
 Output:
 ```
-Detected: Vite
-
-Building...
-> npm run build
-
 Deploying: ./dist
 Found 42 files (1.2 MB)
-Created deployment: 019b1234-5678-...
 Uploading files...
   [100%] 42/42 files
 
 Deployment successful!
-URL:     https://my-website_my-company.zerodeploy.app
-Preview: https://019b1234_my-website_my-company.zerodeploy.app
+URL:     https://my-website.zerodeploy.app
+Preview: https://019b1234-my-website.zerodeploy.app
 ```
 
-#### Preview Deployments
-
-Each deployment gets a unique preview URL that remains accessible even after new deployments:
-
-- **Production URL**: `https://site_org.zerodeploy.app` - Always serves the current deployment
-- **Preview URL**: `https://{shortId}_site_org.zerodeploy.app` - Serves a specific deployment
+#### `zerodeploy deployments list <siteSlug> --org <orgSlug>`
 
-Preview URLs use the first 8 characters of the deployment ID. This is useful for:
-- Reviewing changes before promoting to production
-- Sharing specific versions with stakeholders
-- Rolling back by comparing different deployments
-- PR preview deployments
-
-#### GitHub Actions Integration
-
-ZeroDeploy integrates with GitHub Actions for automated deployments and PR previews.
-
-**Setup:**
-1. Generate a token: Run `zerodeploy login` and copy the token from `~/.zerodeploy/token`
-2. Add the token to your repository secrets as `ZERODEPLOY_TOKEN`
-3. Copy the workflow template to `.github/workflows/deploy.yml`
-
-**Minimal workflow:**
-```yaml
-name: Deploy
-on:
-  push:
-    branches: [main]
-
-jobs:
-  deploy:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: oven-sh/setup-bun@v2
-      - run: bun install
-      - run: bun run build
-      - name: Deploy
-        env:
-          ZERODEPLOY_TOKEN: ${{ secrets.ZERODEPLOY_TOKEN }}
-        run: bunx zerodeploy deploy my-site --org my-org
-```
-
-**PR Preview workflow:**
-```yaml
-- name: Deploy PR Preview
-  if: github.event_name == 'pull_request'
-  env:
-    ZERODEPLOY_TOKEN: ${{ secrets.ZERODEPLOY_TOKEN }}
-  run: |
-    zerodeploy deploy my-site \
-      --org my-org \
-      --pr ${{ github.event.pull_request.number }} \
-      --pr-title "${{ github.event.pull_request.title }}" \
-      --commit ${{ github.sha }} \
-      --branch ${{ github.head_ref }} \
-      --github-output
-```
-
-The `--github-output` flag exports deployment info as GitHub Actions outputs:
-- `deployment_id` - The deployment ID
-- `deployment_url` - The production URL
-- `preview_url` - The unique preview URL
-
-See `apps/cli/examples/github-actions/` for full workflow templates including PR comment automation
-
-#### Framework Auto-Detection
-
-The CLI automatically detects your framework from `package.json` and uses the appropriate build command and output directory:
-
-| Framework | Detection | Build Command | Output Dir |
-|-----------|-----------|---------------|------------|
-| Vite | `vite` in deps | `npm run build` | `dist/` |
-| Next.js | `next` in deps | `npm run build` | `out/` |
-| Create React App | `react-scripts` in deps | `npm run build` | `build/` |
-| Vue CLI | `@vue/cli-service` in deps | `npm run build` | `dist/` |
-| Nuxt | `nuxt` in deps | `npm run build` | `dist/` |
-| Astro | `astro` in deps | `npm run build` | `dist/` |
-| SvelteKit | `@sveltejs/kit` in deps | `npm run build` | `build/` |
-| Gatsby | `gatsby` in deps | `npm run build` | `public/` |
-| Remix | `@remix-run/dev` in deps | `npm run build` | `public/build/` |
-| Parcel | `parcel` in deps | `npm run build` | `dist/` |
-
-**Auto-build behavior:**
-- If a framework is detected but the output directory doesn't exist, the CLI automatically runs the build
-- Use `--no-build` to skip the build step
-- Use `--build-command` to override the detected build command
-
-**Auto-detected directories (fallback):**
-If no framework is detected, the CLI looks for common build output directories:
-1. `dist/` (Vite, Rollup)
-2. `build/` (Create React App)
-3. `out/` (Next.js static export)
-4. `public/` (static sites)
-
-**Ignored files:**
-The following are automatically excluded from deployments:
-- `node_modules/`
-- `.git/`
-- `.env`, `.env.*` files
-- Hidden files starting with `.`
-
-#### `zerodeploy deploy list <siteSlug> --org <orgSlug>`
-
-List all deployments for a site.
+List deployment history for a site.
 
 ```bash
-zerodeploy deploy list my-website --org my-company
-```
-
-Output:
-```
-Deployments for my-company/my-website:
-
-  019b1234  ready       12/14/2025, 9:00:00 PM <- current
-  019b1230  ready       12/14/2025, 8:30:00 PM
-  019b1220  ready       12/14/2025, 8:00:00 PM
+zerodeploy deployments list my-website --org my-company
 ```
 
 **Options:**
-- `--org <orgSlug>` - Organization slug (required)
 - `--limit <number>` - Number of deployments to show (default: 10)
 
-#### `zerodeploy deploy rollback <deploymentId>`
+#### `zerodeploy rollback <siteSlug> --org <orgSlug>`
 
-Rollback to a previous deployment. Sets the specified deployment as the current live deployment.
+Rollback to a previous deployment.
 
 ```bash
-zerodeploy deploy rollback 019b1230-5678-...
-```
+# Rollback to the previous deployment
+zerodeploy rollback my-website --org my-company
 
-Output:
-```
-Rolled back successfully
-   Deployment: 019b1230-5678-...
-   URL: https://my-website_my-company.zerodeploy.app
+# Rollback to a specific deployment
+zerodeploy rollback my-website --org my-company --to 019b1230
 ```
 
 ### Deploy Tokens
 
-Deploy tokens allow CI/CD systems to authenticate with ZeroDeploy without using your personal JWT.
+Deploy tokens allow CI/CD systems to authenticate without using your personal credentials.
 
 #### `zerodeploy token create <name> --org <org> --site <site>`
 
-Create a new deploy token for a site.
+Create a deploy token for CI/CD.
 
 ```bash
 zerodeploy token create "GitHub Actions" --org my-company --site my-website
 ```
 
-Output:
-```
-Deploy token created successfully!
+Save the token securely - it will only be shown once.
 
-Name:  GitHub Actions
-ID:    019b1234-5678-...
-
-Token (save this - it will not be shown again):
+#### `zerodeploy token list --org <org> --site <site>`
 
-  abc123def456...
+List deploy tokens for a site.
 
-Usage in GitHub Actions:
-  Add this token as a repository secret named ZERODEPLOY_TOKEN
+```bash
+zerodeploy token list --org my-company --site my-website
 ```
 
-**Options:**
-- `--org <orgSlug>` - Organization slug (required)
-- `--site <siteSlug>` - Site slug (required)
-
-#### `zerodeploy token list --org <org> --site <site>`
+#### `zerodeploy token delete <tokenId> --org <org> --site <site>`
 
-List all deploy tokens for a site.
+Delete a deploy token.
 
 ```bash
-zerodeploy token list --org my-company --site my-website
+zerodeploy token delete 019b1234 --org my-company --site my-website
 ```
 
-Output:
-```
-Deploy tokens for my-company/my-website:
+## Configuration File
+
+Create a `zerodeploy.json` in your project root:
 
-  019b1234  GitHub Actions        Created: 12/14/2025  Last used: 12/14/2025
-  019b5678  CircleCI              Created: 12/10/2025  Last used: Never
+```bash
+zerodeploy init --org my-company --site my-website
 ```
 
-#### `zerodeploy token delete <tokenId> --org <org> --site <site>`
+This creates:
 
-Delete a deploy token. You can use the full ID or the first 8 characters.
+```json
+{
+  "org": "my-company",
+  "site": "my-website"
+}
+```
+
+Then deploy with just:
 
 ```bash
-zerodeploy token delete 019b1234 --org my-company --site my-website
+zerodeploy deploy
 ```
 
-## Deployment Flow
+## Deployed Sites
 
-1. **Create deployment** - API creates a new deployment record with `uploading` status
-2. **Upload files** - CLI scans directory and uploads each file as base64 to R2
-3. **Finalize** - API marks deployment as `ready` and sets it as the current deployment
-4. **Live** - Site is immediately accessible at the deployment URL
+### URLs
 
-## Accessing Deployed Sites
+Each site gets a production URL based on its subdomain:
 
-After deployment, sites are accessible at:
-
-**Local development:**
 ```
-http://localhost:8787/serve/<orgSlug>/<siteSlug>/
+https://<subdomain>.zerodeploy.app
 ```
 
-**Production:**
+### Preview URLs
+
+Every deployment also gets a unique preview URL that remains accessible even after new deployments:
+
 ```
-https://<siteSlug>_<orgSlug>.zerodeploy.app
+https://<deploymentId>-<subdomain>.zerodeploy.app
 ```
 
+Preview URLs use the first 8 characters of the deployment ID. Useful for:
+- Reviewing changes before promoting to production
+- Sharing specific versions with stakeholders
+- Comparing different deployments
+
 ### SPA Support
 
 ZeroDeploy automatically handles SPA (Single Page Application) routing:
 - Requests without file extensions fall back to `index.html`
-- Enables client-side routing for React, Vue, Angular, etc.
+- Works with React Router, Vue Router, and other client-side routers
 
 ### Caching
 
-Appropriate cache headers are set automatically:
-- **HTML files**: `max-age=0, must-revalidate` (always check for updates)
-- **Hashed assets** (e.g., `main.abc123.js`): `max-age=31536000, immutable` (1 year)
-- **Other assets**: `max-age=3600, stale-while-revalidate=86400` (1 hour)
+Cache headers are set automatically:
+- **HTML files**: Always revalidate for fresh content
+- **Hashed assets** (e.g., `main.abc123.js`): Cached for 1 year
+- **Other assets**: Cached for 1 hour with background revalidation
+
+## CI/CD Integration
+
+### GitHub Actions
 
-## Configuration
+**1. Create a deploy token:**
 
-### Token Storage
+```bash
+zerodeploy token create "GitHub Actions" --org my-company --site my-website
+```
 
-Authentication token is stored at `~/.zerodeploy/token`.
+**2. Add the token to your repository secrets** as `ZERODEPLOY_TOKEN`
 
-For CI/CD, set the `ZERODEPLOY_TOKEN` environment variable instead. The environment variable takes precedence over the file-based token.
+**3. Create `.github/workflows/deploy.yml`:**
 
-### API URL
+```yaml
+name: Deploy
+on:
+  push:
+    branches: [main]
 
-By default, CLI connects to production (`https://api.zerodeploy.dev`). To use a local development server, set the `ZERODEPLOY_API_URL` environment variable:
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+      - run: npm ci
+      - run: npm run build
+      - name: Deploy
+        env:
+          ZERODEPLOY_TOKEN: ${{ secrets.ZERODEPLOY_TOKEN }}
+        run: npx @zerodeploy/cli deploy my-site --org my-org
+```
 
-```bash
-# Point to local dev server
-export ZERODEPLOY_API_URL=http://localhost:8787
+**PR Preview workflow:**
 
-# Or prefix individual commands
-ZERODEPLOY_API_URL=http://localhost:8787 zerodeploy whoami
+```yaml
+name: PR Preview
+on:
+  pull_request:
+
+jobs:
+  preview:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+      - run: npm ci
+      - run: npm run build
+      - name: Deploy Preview
+        env:
+          ZERODEPLOY_TOKEN: ${{ secrets.ZERODEPLOY_TOKEN }}
+        run: |
+          npx @zerodeploy/cli deploy my-site \
+            --org my-org \
+            --pr ${{ github.event.pull_request.number }} \
+            --pr-title "${{ github.event.pull_request.title }}" \
+            --commit ${{ github.sha }} \
+            --branch ${{ github.head_ref }} \
+            --github-output
 ```
 
-Make sure your local API is running with `cd apps/api && bun run dev`.
+The `--github-output` flag exports deployment info as GitHub Actions outputs:
+- `deployment_id` - The deployment ID
+- `deployment_url` - The production URL
+- `preview_url` - The unique preview URL
 
-## Development
+### Other CI/CD Systems
+
+ZeroDeploy works with any CI/CD system. Set the `ZERODEPLOY_TOKEN` environment variable and run the deploy command:
 
 ```bash
-# Run CLI in development
-cd apps/cli
-bun run src/index.ts <command>
+# Works with npm, yarn, pnpm, or bun
+npx @zerodeploy/cli deploy my-site --org my-org
+yarn dlx @zerodeploy/cli deploy my-site --org my-org
+pnpm dlx @zerodeploy/cli deploy my-site --org my-org
+bunx @zerodeploy/cli deploy my-site --org my-org
+```
+
+## Framework Auto-Detection
+
+The CLI automatically detects your framework and uses the appropriate build command and output directory:
+
+| Framework | Build Command | Output Dir |
+|-----------|---------------|------------|
+| Vite | `npm run build` | `dist/` |
+| Next.js | `npm run build` | `out/` |
+| Create React App | `npm run build` | `build/` |
+| Vue CLI | `npm run build` | `dist/` |
+| Nuxt | `npm run build` | `dist/` |
+| Astro | `npm run build` | `dist/` |
+| SvelteKit | `npm run build` | `build/` |
+| Gatsby | `npm run build` | `public/` |
+| Remix | `npm run build` | `public/build/` |
+| Parcel | `npm run build` | `dist/` |
+
+**Auto-detected directories (fallback):**
+If no framework is detected, the CLI looks for: `dist/`, `build/`, `out/`, `public/`
 
-# Run tests
-bun test
+**Ignored files:**
+The following are automatically excluded from deployments:
+- `node_modules/`
+- `.git/`
+- `.env`, `.env.*` files
+- Hidden files starting with `.`
 
-# Run e2e tests (requires API running)
-bun test test/e2e.test.ts
-```
+## Environment Variables
+
+| Variable | Description |
+|----------|-------------|
+| `ZERODEPLOY_TOKEN` | Authentication token (for CI/CD) |
+| `ZERODEPLOY_API_URL` | Custom API URL (defaults to production) |
 
 ## Troubleshooting
 
@@ -512,12 +398,20 @@ Run `zerodeploy login` to authenticate.
 
 ### "Org not found"
 
-Ensure you're using the correct org slug (lowercase, hyphenated). Use `zerodeploy org list` to see your organizations.
+Use the correct org slug (lowercase, hyphenated). Check with `zerodeploy org list`.
 
 ### "Site not found"
 
-Ensure you're using the correct site slug and org slug. Use `zerodeploy site list <orgSlug>` to see sites.
+Use the correct site and org slugs. Check with `zerodeploy site list <orgSlug>`.
 
 ### "No build directory found"
 
-Specify the directory explicitly with `--dir ./path/to/build` or ensure your project has a `dist/`, `build/`, `out/`, or `public/` directory.
+Either:
+- Specify the directory with `--dir ./path/to/build`
+- Run with `--build` to build first
+- Ensure your project has a `dist/`, `build/`, `out/`, or `public/` directory
+
+## Links
+
+- [Documentation](https://zerodeploy.dev/docs)
+- [Support](https://zerodeploy.dev/support)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zerodeploy/cli",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "type": "module",
   "bin": {
     "zerodeploy": "dist/cli.js"
@@ -23,11 +23,6 @@
   "publishConfig": {
     "access": "public"
   },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/zerodeploy/zerodeploy.git",
-    "directory": "apps/cli"
-  },
   "keywords": [
     "deploy",
     "spa",