CLI Reference

noboil — schema-first, zero-boilerplate fullstack

Usage:
  noboil <command> [options]

Commands:
  add          Add a table/endpoint (auto-detects DB from .noboilrc.json)
  completions  Print or install shell completion script
  convex       Run a Convex subcommand (add, check, docs, migrate, viz, doctor)
  doctor       Check project health and version alignment
  eject        Detach from upstream, convert to standalone
  init         Create a new noboil project
  status       Show project drift, last sync, and health at a glance
  stdb         Run a SpacetimeDB subcommand (add, dev, generate, migrate, use, viz, ...)
  sync         Pull and apply upstream changes
  tool         Run or scaffold a tool (new, remove, codegen, docgen, or <provider> <name>)
  upgrade      Install the latest noboil version

Run noboil <command> --help for command-specific options.

noboil init — create a new noboil project

Usage:
  noboil init [directory]

Options:
  --db=convex|spacetimedb    Skip database prompt
  --no-demos                 Skip demo apps
  --skip-install             Skip bun install after scaffolding
  --no-git                   Skip auto git init + initial commit
  --help, -h                 Show this help

noboil doctor — check project health
Usage:
  noboil doctor [--fix] [--last-error]
Options:
  --fix          Auto-remediate common issues (install deps, patch tsconfig)
  --last-error   Print the most recent crash log
  --help, -h     Show this help

noboil status — snapshot of the current project
Usage:
  noboil status
Shows: database, scaffolded-from hash, drift vs upstream, last sync, install health.

noboil sync — pull upstream changes

Usage:
  noboil sync [options]

Options:
  --dry-run                  Show what would change without writing files
  --force                    Update files even when locally modified
  --help, -h                 Show this help

noboil eject — inline noboil library locally

Usage:
  noboil eject [--dry-run] [--yes]

Options:
  --dry-run      Show what would change without writing files
  --yes, -y      Skip confirmation prompt
  --help, -h     Show this help

noboil upgrade — install latest noboil
Usage:
  noboil upgrade [--global]
Options:
  --global, -g   Upgrade the globally installed binary (bun add -g noboil@latest)
  --help, -h     Show this help

noboil/convex — Zod schema → fullstack app

Usage:
  noboil convex <command> [options]

Commands:
  add              Add a new table/endpoint to your project
  check            Validate schema/factory consistency
  docs             Generate API documentation
  doctor           Run project diagnostics
  migrate          Schema diff and migration plans
  viz              Visualize schema relationships

Run noboil convex <command> --help for command-specific options.

noboil convex add — add a new table/endpoint to your project

Usage:
  noboil convex add <table-name> [options]

Options:
  --type=TYPE           Table type: owned, org, singleton, cache, child, log, kv, quota (default: owned)
  --fields=FIELDS       Field definitions (e.g. "title:string,done:boolean,priority:enum(low,medium,high)")
  --parent=TABLE        Parent table name (required for child type)
  --convex-dir=DIR      Convex directory (default: convex)
  --app-dir=DIR         App directory (default: src/app)
  --help, -h            Show this help

Examples:
  $ noboil convex add todo --fields="title:string,done:boolean"
  $ noboil convex add wiki --type=org --fields="title:string,content:string,status:enum(draft,published)"
  $ noboil convex add message --type=child --parent=chat --fields="text:string"
  $ noboil convex add profile --type=singleton --fields="displayName:string,bio:string?"
  $ noboil convex add movie --type=cache --fields="title:string,tmdb_id:number"
  $ noboil convex add vote --type=log --parent=poll --fields="optionIdx:number,voter:string"
  $ noboil convex add siteConfig --type=kv --fields="active:boolean,message:string"
  $ noboil convex add apiQuota --type=quota

noboil stdb — Zod schema → fullstack app

Usage:
  noboil stdb <command> [options]

Commands:
  add              Add a new table/reducer to your project
  check            Validate schema/reducer consistency
  dev              Start integrated local development workflow
  docs             Generate API documentation
  doctor           Run project diagnostics
  generate         Generate project files (docker-compose, etc.)
  migrate          Schema diff and publish migration plans
  use              Switch SpacetimeDB target (local / cloud)
  validate         Lint schema, reducers, indexes, and access control
  viz              Visualize schema relationships

Run noboil stdb <command> --help for command-specific options.

noboil stdb add — add a new table/reducer to your project

Usage:
  noboil stdb add <table-name> [options]

Options:
  --type=TYPE           Table type: owned, org, singleton, cache, child, log, kv, quota (default: owned)
  --fields=FIELDS       Field definitions (e.g. "title:string,done:boolean,priority:enum(low,medium,high)")
  --parent=TABLE        Parent table name (required for child type)
  --module-dir=DIR      SpacetimeDB module directory (default: module)
  --app-dir=DIR         App directory (default: src/app)
  --help, -h            Show this help

Examples:
  $ noboil stdb add todo --fields="title:string,done:boolean"
  $ noboil stdb add wiki --type=org --fields="title:string,content:string,status:enum(draft,published)"
  $ noboil stdb add message --type=child --parent=chat --fields="text:string"
  $ noboil stdb add profile --type=singleton --fields="displayName:string,bio:string?"
  $ noboil stdb add movie --type=cache --fields="title:string,externalId:string"
  $ noboil stdb add vote --type=log --parent=poll --fields="option:string"
  $ noboil stdb add siteConfig --type=kv --fields="active:boolean,message:string"
  $ noboil stdb add apiQuota --type=quota

noboil init [directory]

bunx noboil@latest init my-app

bunx noboil@latest init my-app --db=spacetimedb --no-demos --skip-install

$ bunx noboil@latest init my-app

  Pick your database:
    1. Convex (hosted, reactive queries, server functions)
    2. SpacetimeDB (self-hosted, subscriptions, Rust module)

  Choice (1/2): 1
  Include demo apps? (Y/n): Y
  Project directory: my-app

  ✓ scaffolding...
  ✓ cleaning up unused files...
  ✓ patching package.json...
  ✓ installing dependencies...

  Done! Project created at my-app

  $ cd my-app
  $ bun setup:convex     # or bun setup:spacetimedb
  $ bun dev

  Docs: https://noboil.dev/docs

{
  "db": "convex",
  "includeDemos": true,
  "scaffoldedAt": "2026-04-13T...",
  "scaffoldedFrom": "abc1234",
  "version": 1
}

noboil doctor [--fix] [--last-error]

noboil status

noboil upgrade [--global]

noboil completions bash | zsh | fish            # print to stdout
noboil completions install bash | zsh | fish    # append to your shell rc

noboil sync [options]

noboil sync

noboil sync --dry-run

noboil sync --force

noboil eject [options]

noboil eject

noboil eject --dry-run

noboil convex add post            # same as noboil convex add post
noboil stdb add post              # same as noboil stdb add post
noboil add post                   # auto-dispatches based on .noboilrc.json

import { defineConfig } from 'noboil/config'
export default defineConfig({
  hooks: {
    beforeAdd: async ({ db, name, type, fields }) => {
      // runs before 'noboil add' writes files
      // throw to cancel
    },
    afterAdd: async ({ db, name, type, fields }) => {
      // runs after files are written
      // e.g. notify team Slack, run a formatter, etc.
    }
  }
})