Install DataBull

One command puts DataBull on your own Cloudflare account. It takes about three minutes, and you can run it again any time: it picks up where it left off.

What you need

Run the installer

Open Terminal (on a Mac: ⌘ Space, type Terminal; on Windows: PowerShell) and run:

npx databull@latest

Got here from the thanks page? Its command already has your key in it: npx databull@latest --key YOUR-KEY.

What you'll see, step by step

  1. License key. Paste your key (skipped if you passed --key). It's checked straight away and uses one of the key's 3 activations.
  2. Cloudflare sign-in. If this computer isn't signed in yet, a browser tab opens on Cloudflare. Click Allow, then come back to Terminal. Nothing to copy or paste.
  3. Account. Have more than one Cloudflare account? Pick the one DataBull should live in.
  4. workers.dev subdomain. Every Cloudflare account gets a free address like yourname.workers.dev. Brand-new accounts don't have one yet; the installer offers to create it.
  5. Name. The name of the Worker and database, databull by default. If a Worker with that name already exists, you're offered an update instead.
  6. Address. Use the free databull.yourname.workers.dev address, or a subdomain of a site already on this Cloudflare account, such as analytics.yourapp.com. You can change it later (see Custom domain).
  7. Database. A D1 database is created in your account (or reused, if an empty one with that name exists).
  8. Download. The latest DataBull release is downloaded and its checksum verified.
  9. Deploy. The database schema is applied and the Worker is deployed with freshly generated secrets. The secrets never leave your computer and your Cloudflare account.
  10. Going live. The installer waits until your dashboard answers. On a new account, Cloudflare can take a few minutes to switch on a workers.dev address or a certificate; the installer waits up to 5 minutes and tells you what's happening.
  11. First login. Your browser opens /setup on your new dashboard. Pick your email and password: that's the owner account.

It ends with a summary like this:

✓ DataBull is live

  Dashboard   https://databull.yourname.workers.dev
  Update      npx databull@latest update
  Password    npx databull@latest reset-password
  Domain      npx databull@latest domain
  Docs        https://databull.app/docs

Next: add your first website. Curious what runs where? See self-hosting on Cloudflare.

If something fails

Every error says what happened and what to do, plus the path of a full log in ~/.databull/logs. Fix the cause and run the same command again: it reuses what was already created. Common cases are in Troubleshooting.

All commands

CommandWhat it does
npx databull@latestInstall (same as install).
updateUpdate to the latest version. Updating
reset-passwordSet a new password. Reset password
domainAdd or change the address. Custom domain
statusShow your installs, their versions and whether they're up.
licenseShow the license on this install; --deactivate frees its activation.
uninstallRemove DataBull from Cloudflare. Uninstall
help, --versionHelp and the installer's version.

Flags for scripts and CI

--key <key>, --account <id>, --name <worker>, --domain <host|workers.dev>, --yes (accept defaults), --no-open (don't open the browser). The installer keeps its state in ~/.databull.