Which one do I want?
Two questions get you to the right page. What do you want to do, and then which shape of it. If the word instance is doing more work than you would like, what an instance is answers that first and takes a minute.
Already have an address from someone else? You want the SDK or the admin panel, and nothing on this page.
I want one running
No code of your own. A working backend with an admin panel, in about a minute.
- on this machine, with nothing installedStandalone executableOne file holding the server, the panel and the database. No npm, no build, no account.
./voidbase serve - from a terminal, locally or on CloudflareWith the npm CLIMake, list and delete instances by name. They run wherever the CLI does, on a laptop, inside a container, bundled into a desktop app, or in your own Cloudflare account. The same commands for all of them.
bun i -g @voidbase-cloud/voidbase - from a dashboard, with nothing to installvoidbase cloudsoonSign in, name it, and it is provisioned for you. Still experimental.
I want it in a repository from the start
Your endpoints, your schema and your configuration are files you commit, and the instance is built out of them.
- on my own server, with nothing installedA directory the binary servesThe three tracked directories, served by the executable. No npm and no build, which also means no Cloudflare.
./voidbase init - as a backend my app talks toA voidbase projectPocketBase's layout, so it drops into whatever stack you already have. Pick this if your frontend exists.
voidbase init - as one application, site includedThe voidbase stackPages, typed routes and the backend in one project, deployed as a single Worker. Pick this if you are starting from nothing.
bunx void init
I already have one running
You made an instance, designed collections in the panel, and now you want that in git. It keeps running while you do.
- and I want to stay on my own machineInto a directory the binary servesTrack what defines it, keep serving it with the executable, and add nothing to the machine.
voidbase export ./snapshot - and I want it on CloudflareInto a voidbase projectThe npm layout, which is the one that deploys, and a push that becomes the deploy.
voidbase sync --repo you/blog-api - and I want the site in there tooInto a voidbase stackOne repository and one Worker holding the application and the backend together.
bunx void init
Then, whichever you picked
Still not sure?
Take the standalone executable. It is one file, it needs nothing installed, and it deletes cleanly, so it is the cheapest way to find out whether any of this is what you wanted. Everything you build against it works against every other option on this page, because they are all the same server.
Nothing here is a one-way door either. The third branch above exists because starting without a repository is the normal thing to do, and turning what you made into one is three commands whenever you are ready.
Fix it yourself. The link below opens this file in GitHub's editor and forks the repository for you if you need one, and your change becomes a pull request without leaving the browser.