Skip to main content
Use init after package install or when setup needs repair. The command scaffolds config, schema directories, migration directories, and path-confirmation state. It does not install active AI-agent rules, skills, hooks, settings, AGENTS.md, or CLAUDE.md by default.

​
Use this when

  • supaschema was installed in a project that has not been set up yet.
  • supaschema.config.json should be repaired from the canonical contract.
  • The user has reviewed node_modules/supaschema/agent-bundle/INSTALL.md and explicitly asks to install AI-agent enforcement with --agent-bundle.

​
Run it

<local-runner> init
<local-runner> init --agent-bundle
<local-runner> init --dry-run --json
<local-runner> init --repair
Existing config files are left untouched unless --repair is passed.

​
Flags

​
--dry-run
boolean
Print the scaffold or repair plan without writing files.
​
--json
boolean
Print the init result as redacted JSON.
​
--repair
boolean
Rewrite supaschema.config.json from the canonical contract when needed.
​
--agent-bundle
boolean
Install the reviewed raw AI-agent bundle into .agents, .claude, .codex, AGENTS.md, and CLAUDE.md. Do not use this flag unless the user asks for AI-agent enforcement or approves the bundle.

Installation

Add supaschema to a project.

Setup

Confirm generated paths and files.

What's included

See the package and agent surfaces.

Config validate

Check the generated config.
Last modified on June 19, 2026