CLI Commands

Create a Flutter app wired to your Koolbase project — opinionated architecture, authentication generated, running in about two minutes. See Scaffolding for what it produces.

koolbase create my_app
koolbase create my_app --flavors --template chat

Install a template into an existing Flutter project. Reads your package name and Koolbase project from the app itself. Existing files are listed and refused rather than overwritten.

koolbase add chat
koolbase add [email protected] --force

Authenticate with your Koolbase account. Opens your browser to sign in with Google by default; use --github for GitHub, or --password for email and password. Saves your session to ~/.koolbase/config.json.

koolbase login --github

Link an additional sign-in provider (google or github) to your account. You must be logged in first. Opens a browser flow and attaches the provider to your existing account rather than creating a new session.

koolbase connect github

End your session on the server and remove saved credentials from this machine. Local credentials are cleared even if the server can't be reached.

koolbase logout

Show which account the CLI is logged in as — verified live against the API. A stale or revoked session reports as such instead of failing later mid-command.

koolbase whoami

Mint an organization API key for programmatic access (CLI, MCP server, CI). The secret is shown once and printed with a ready-to-paste MCP config. Requires a logged-in session — keys cannot mint keys.

koolbase keys create --name claude-desktop --scope write

List your organization's API keys with prefix, scope, last-used time, and revoked status.

koolbase keys list

Revoke an API key. Takes effect immediately — anything authenticating with it stops working on its next request.

koolbase keys revoke 4e1cd5b6-bc92-4c2d-98f1-a47dd6931828

Wire the Koolbase MCP server into Claude Desktop in one command: writes the config entry pointing at this binary, preserving any existing servers and backing up the old file. Then fully quit and reopen Claude Desktop.

koolbase mcp install --key kb_live_your_key_here

Run the MCP server over stdio. MCP clients (Claude Desktop, Cursor, others) launch this — you rarely run it directly. Requires the KOOLBASE_API_KEY environment variable; it will not fall back to your login session.

KOOLBASE_API_KEY=kb_live_... koolbase mcp serve

Apply a Designer export to a project on disk. Koolbase's files — lib/generated/, test/generated/ and lib/l10n/app_en.arb — are replaced whole; everything else is yours and is left alone. Refuses rather than overwrite if a generated file was edited by hand.

koolbase export apply ~/Downloads/koolbase_export.zip --into ./my_app
# Exported 34 files into ./my_app
# lib/generated/ is Koolbase's and is replaced on re-export.
# Everything else is yours; build outside lib/generated/.

List the projects in the organization you are signed in to, with their IDs, so you can find a project ID without opening the dashboard. Your saved default project is marked with *.

koolbase projects list
koolbase projects list --json

Deploy a function from a local file. Runtime is auto-detected from the file extension — .ts deploys to Deno, .dart deploys to the Dart runtime.

koolbase deploy send-email --file ./send_email.ts --project proj_123
koolbase deploy process --file ./process.dart --project proj_123

List all deployed functions in a project with version, runtime, timeout, and last deployed date.

koolbase functions list --project proj_123

Invoke a deployed function with an optional JSON body. Prints the status code, response body and log ID. If the function fails, it says so, names the ctx.db call that failed and its status when that is the cause, shows the log ID, and exits with a non-zero code so scripts and CI notice.

koolbase invoke send-email --project proj_123
koolbase invoke send-email --project proj_123 --data '{"to":"[email protected]"}'

View recent execution logs for a function. Shows status, duration, output, and errors.

koolbase logs send-email --project proj_123
koolbase logs send-email --project proj_123 --limit 50

List the project's triggers: ID, function, event, target, whether each is enabled, and when it was created.

koolbase triggers list --project proj_123

Bind a function to an event, using the event names on the Triggers page, such as db.record.created, storage.object.created or auth.user.registered. insert, update and delete are accepted as short names for the db.record.* events. The server rejects an unknown event and lists every supported one.

koolbase triggers create --function notify --event db.record.created --collection orders
koolbase triggers create --function resize --event storage.object.created --collection avatars
koolbase triggers create --function welcome --event auth.user.registered

Delete a trigger. The function stays deployed; it just stops firing for that event.

koolbase triggers delete 3f2c9a1e --project proj_123

Run a db.record.created or db.record.updated trigger for the records already in its collection, oldest first, as if each had just been created or updated. For data seeded before the trigger existed. Deliveries are paced through the retry queue. Run with --dry-run first: it only counts.

koolbase triggers replay 3f2c9a1e --project proj_123 --dry-run
koolbase triggers replay 3f2c9a1e --project proj_123

Send a collection's record events to an HTTPS URL (port 443 or 8443), signed, with retries. Prints the signing secret once: store it straight away. Owners and admins only. See Database > Webhooks for the payload and how to verify the signature.

koolbase webhooks create --url https://example.com/hook --collection orders --event insert
koolbase webhooks create --url https://example.com/hook --collection orders --event insert,update,delete

List the project's webhooks: ID, collection, enabled, events and URL. Secrets are never shown.

koolbase webhooks list --project proj_123

Recent deliveries for a webhook: event, status (pending, delivered or failed), attempt, the receiver's HTTP code and any error.

koolbase webhooks deliveries 3f2c9a1e --project proj_123

Send a delivery again, from the first attempt.

koolbase webhooks redeliver 8d1e44b2 --project proj_123

Delete a webhook and its delivery log.

koolbase webhooks delete 3f2c9a1e --project proj_123

Run a function in this project later, with retries (the same schedule and dead-letter queue as triggers). Owners and admins only. From inside a function, use ctx.queue.enqueue instead. See Functions > Queues.

koolbase queue enqueue send-welcome-email --payload '{"userId":"u_123"}' --delay 60

Pending jobs, soonest first: job ID, function, attempt, when it runs, and the last error if it has failed before.

koolbase queue list --project proj_123

Remove a job before it runs.

koolbase queue cancel e6d97d4f --project proj_123

List all cron schedules in a project with their expressions, status, and last run time.

koolbase crons list --project proj_123

Add a cron schedule for a deployed function using a standard 5-field cron expression.

koolbase crons add send-email --cron "0 9 * * *" --project proj_123
koolbase crons add cleanup --cron "*/5 * * * *" --project proj_123

Enable or disable a cron schedule without deleting it.

koolbase crons toggle 18f79c3a --disable --project proj_123
koolbase crons toggle 18f79c3a --enable --project proj_123

Permanently delete a cron schedule.

koolbase crons delete 18f79c3a-1965-44a5-8ff2-1d35ac58ede8 --project proj_123