Loading article…
OperationsUse the qb CLI
QB Flex / v0.1
Documentation lives with the code. API references are generated from the same contracts.
DocsOperationsUse the qb CLI
DocsLoading article…
bun run qb login --url http://localhost:7612 --email owner@example.com
bun run qb projects list
bun run qb link --project YOUR_PROJECT_ID --branch primaryOn macOS, login reads the password from a hidden interactive prompt and stores a 30-day management token in the OS keychain. Add --organization ORGANIZATION_ID only when the CLI must provision projects. Linux and CI use QB_MANAGEMENT_TOKEN: create the scoped token in Studio Settings after completing administrator MFA and inject it through your protected environment store. The CLI does not print or write credentials to a plaintext configuration file.
bun run qb db migrate --file migrations/001_tasks.sql --id 001_tasks
bun run qb db export --table tasks --output tasks.json
bun run qb db import --table tasks --file tasks.json
bun run qb types generate --output qb-flex.types.tsMigrations and table writes require developer permissions. Import uses bounded batches; an import spanning batches is not a single all-or-nothing transaction.
bun run qb backup create
bun run qb backup restore --backup YOUR_BACKUP_IDRestore creates a new isolated branch. It does not switch primary traffic automatically. Perform cutover deliberately through management operations after validating the restored branch.
qb init writes a local configuration file without credentials. qb dev starts the workspace processes. Commands accept explicit project/branch flags, with linked defaults for convenience.
General branch creation, functions, hosted MCP and remote reset are not enabled in P0. Unsupported commands return an actionable error rather than simulating success.
qb db reset --data-dir .data --confirm-local-reset requires a stopped API and a disposable local directory with a generated master key. It removes the local databases and generated local keys. It never selects a remote branch by default.
qb secrets set --name SERVICE_SECRET --env MY_SECRET reads a secret from the named environment variable, stores an encrypted version and returns only its identifier. Viewer access cannot recover secret values.
qb storage sync --bucket BUCKET_ID --directory ./attachments adds missing objects from a local directory. Existing and remote-only objects are preserved. Hidden files and symlinks are skipped. Use the explicit object APIs for deletion.
qb db diff --file expected-schema.json compares the current introspected schema with your checked-in schema manifest. It reports column differences; it does not invent a migration.
bun run qb doctor --directory . reports structured, redacted readonly inventory. No implicit network probes, writes, email or push. Use --probe-url https://your-api.example.com for an explicit bounded readiness GET; values and paths remain redacted. Exit0 means no blocking inventory errors,1 means errors,2 means invalid invocation. Unknown provider/native/recovery checks are not reported as healthy.
See the Deployment Doctor guide for exact probe restrictions, findings and limitations. Preview environments, push campaign tools and advanced recovery commands are not available simply because specification 1.1 defines them.
With the API stopped, qb backup control-create --data-dir DIRECTORY writes a streamed encrypted v2 control archive. qb backup control-restore --data-dir DIRECTORY --file ARCHIVE --confirm-local-control-restore accepts new and legacy control archives, verifies them and replaces the stopped catalog only after an encrypted rollback checkpoint. Preserve all referenced branch files and the original master key. Restored sessions/credentials do not revive; reissue project/management keys. Both commands wait for streams and hold exclusive volume ownership. See control recovery and limits.
qb db migrate-engine --from sqlite --to pglite --data-dir SOURCE --output-dir DESTINATION --check reports compatibility. Omit --check to create and validate a separate PGlite installation while preserving the source. Stop writers first; see engine migration.