create-objectstack

Scaffold a new ObjectStack project in seconds.

npm create objectstack@latest my-app

Usage

# Create a project in a new directory (blank template)
npx create-objectstack my-app

# Use a specific template
npx create-objectstack my-app --template todo

# Scaffold in the current directory
npx create-objectstack

# Skip automatic dependency installation
npx create-objectstack my-app --skip-install

Templates

| Template | Source | Description | | --- | --- | --- | | blank (default) | bundled (offline) | Minimal starter — one object, REST API, ready to extend |

blank is bundled inside the npm package, so scaffolding never needs network access.

The remote content templates (todo, compliance, content, contracts, procurement) have been retired — they were delisted from the ObjectStack template marketplace and are no longer maintained. Asking for one by name tells you so rather than failing as an unknown template.

Options

| Option | Description | | --- | --- | | [name] | Project name (defaults to current directory name) | | -t, --template <name> | Project template (default: blank) | | --skip-install | Skip dependency installation | | --skip-skills | Skip installing the ObjectStack AI skills bundle | | -V, --version | Show version | | -h, --help | Show help |

What it does

1. Copies the template into the target directory and rewrites its identity: package.json name, objectstack.manifest.json name/displayName, the objectstack.config.ts manifest literals, and the README title. A namespace is derived from the project name (my-app → my_app) and every object name in the template is re-prefixed to match (blank_note → my_app_note).
2. Installs dependencies (pnpm if available, otherwise npm).
3. Installs the ObjectStack AI skills bundle for one coding agent — npx skills add objectstack-ai/objectstack/skills --skill '*' --agent claude-code -y, scoped to the curated skills/ catalog. One agent, not --all, so the bundle lands in exactly one directory (.claude/skills/) and a scaffolded project commits it once; src/skills-install.ts carries the measurement. The closing summary prints the same command for any other runtime.
4. Writes AGENTS.md and .github/copilot-instructions.md with the project conventions — unless the template ships its own.

What Gets Generated (blank)

my-app/
├── objectstack.config.ts        # defineStack() entry point
├── objectstack.manifest.json    # name, namespace, version
├── package.json
├── tsconfig.json
├── .gitignore
├── README.md
├── AGENTS.md                    # conventions for coding agents
└── src/
    └── objects/
        ├── index.ts
        └── note.object.ts

Next steps inside the project:

npm run dev        # start the dev server
npm run validate   # verify metadata: schema + predicates + bindings

See the docs: Your First Project.

License

Apache-2.0. See LICENSING.md.