Install

npm install -g dropweb

Requires Node.js 18+. Also works with npx:

npx dropweb ./my-site

Quick Start

# Create something
mkdir my-site && echo "<h1>Hello World</h1>" > my-site/index.html

# Deploy it
dropweb my-site

#  ✓ Live at https://cool-red-fox.dropweb.app
#    Screenshot: https://screenshot.dropweb.app/cool-red-fox.jpg
#    Key saved to ~/.config/dropweb/config.json

That's it. No account, no dashboard, no YAML. One command, one URL.

Commands

Deploy

dropweb .                    # Deploy current directory
dropweb dist                 # Deploy a subfolder
dropweb ./my-site            # Deploy any folder with index.html

First deploy creates an anonymous account and saves the API key automatically. Subsequent deploys from the same folder update the same site.

Manage Sites

dropweb list                 # List all your sites
dropweb info <siteId>        # Site details + deploy history
dropweb delete <siteId>      # Permanently delete a site

Account

dropweb account              # Show tier, limits, expiry
dropweb email [email protected] # Upgrade: 3 days → 30 days
dropweb login [email protected] # Log in via email (sends key, paste it)
dropweb login sk_yourkey     # Log in with a key directly
dropweb recover [email protected] # Lost your key? Recover via email
dropweb whoami               # Show saved key + config path

How It Works

                    first deploy
  dropweb dist ──────────────────► api.dropweb.app/deploy
       │                                  │
       │                          returns URL + key
       │                                  │
       ▼                                  ▼
  .dropweb          ~/.config/dropweb/config.json
  (siteId)                (API key)

                    redeploy
  dropweb dist ──────────────────► api.dropweb.app/deploy/cool-red-fox
       │                                  │
   reads .dropweb                   updates same site
   for siteId                       resets expiry

1. First deploy → anonymous account created, key returned and saved
2. Key stored in ~/.config/dropweb/config.json (XDG, mode 600)
3. Site ID stored in .dropweb in your project folder
4. Redeploy from same folder → updates existing site
5. Attach email → upgrade from 3-day to 30-day expiry + key recovery

Tiers

| | Anonymous | Free (with email) | |---|---|---| | Sites | 3 | 5 | | Expiry | 3 days | 30 days (resets on redeploy) | | Key recovery | ❌ | ✅ via email | | Deploy rate | 5/hr | 10/hr |

Upgrade anytime:

dropweb email [email protected]

File Storage

| File | Contents | Sensitive? | Git? | |---|---|---|---| | ~/.config/dropweb/config.json | API key, email | 🔒 Yes | Never | | .dropweb (in project root) | siteId | No | Optional |

The config directory follows the XDG Base Directory spec. Override with $XDG_CONFIG_HOME.

CI/CD

Use environment variables or dropweb login in your pipeline:

# GitHub Actions
- run: |
    npm install -g dropweb
    dropweb login ${{ secrets.DROPWEB_KEY }}
    dropweb dist

# GitLab CI
deploy:
  script:
    - npm install -g dropweb
    - dropweb login $DROPWEB_KEY
    - dropweb dist

For AI Agents

DropWeb is designed to be agent-friendly. If you're building tools that deploy sites:

• CLI: npx dropweb ./folder — zero config
• curl: curl -F "[email protected]" https://api.dropweb.app/deploy — no CLI needed
• API docs: dropweb.app/help
• LLM docs: dropweb.app/llms.txt
• OpenAPI: dropweb.app/openapi.json

Links

• 🌐 Website: dropweb.app
• 📖 API Reference: dropweb.app/help
• 🤖 LLM Docs: dropweb.app/llms.txt

License

MIT