CLI
Reference
All available Typebase CLI commands.
Last updated on
The Typebase CLI is the main tool for managing your project. It handles code generation, deployment, database management, and more.
Usage
npx typebase-io-cli <command> [options]If you installed the CLI globally, you can also run:
typebase-io-cli <command> [options]Commands
| Command | Description |
|---|---|
init | Scaffold a new Typebase project structure |
codegen | Regenerate type definitions |
deploy | Build and deploy your server to the cloud |
generate-server | Generate server files locally without deploying |
db | Manage your database (push or pull your schema) |
auth | Manage authentication (generate auth tables) |
env | Manage environment variables on your deployment provider |
logs | Stream runtime logs from your deployed server |
config | Print the config schema annotated with the current values |
Versions
npx typebase-io-cli --version prints the version of the CLI you are running.
The CLI and typebase-io are released together and share a version number. Before running a command that needs the package, the CLI compares its own version against the installed typebase-io and warns when they differ:
Warning: this CLI is 0.1.15, but the installed `typebase-io` is 0.1.14. They are released together, so generated code and
deploys can break while they differ. Install `typebase-io@0.1.15`, or run the CLI as `npx typebase-io-cli@0.1.14`.It's a warning, not an error, so the command still runs. env, logs and config don't need typebase-io at all and skip the check.