Generator

create-index creates an Index workspace from deterministic CLI arguments. It is non-interactive by default so generated files can be reviewed, tested, and reproduced.

Usage

npx create-index --name "Example Client" --output ./example-client [options]

The local development entry point is:

node generator/create-index.mjs --name "Example Client" --output ./example-client --skip-install

Required Inputs

Option	Description
--name <name>	Human-facing repository or workspace name.
--output <path>	Directory to create.

Common Options

Option	Description
--slug <slug>	Machine slug. Defaults to a slugified --name.
--profile <name>	Profile from generator/profiles. Defaults to public-template.
--features <list>	Comma-separated feature list.
--owner <name>	Owning team or organization.
--visibility <value>	public, internal, or private. Defaults to private.
--repo-type <value>	client, project, internal, reference, or repo.
--services <list>	Comma-separated service names to document.
--package-manager <name>	npm, pnpm, bun, or yarn. Defaults to npm.
--updated-at <YYYY-MM-DD>	Metadata date. Defaults to today.
--config <path>	YAML or JSON config file. Flags override config values.
--dry-run	Print the files that would be written.
--force	Allow writing into an existing directory.
--skip-install	Do not run package-manager install.
--git-init	Initialize a git repository after generation.
--run-checks	Run generated validation checks after generation.
--print-prompt	Print the agent planning prompt.

Profiles

Profiles live in generator/profiles/ and select default feature bundles.

Profile	Best fit
public-template	Public starter template or reusable open workspace.
company-brain	Private operating memory for teams, repositories, vendors, decisions, and next actions.
client-workspace	Delivery workspace for client context, repo intelligence, runbooks, and evals.
repo-intelligence	Internal map of codebases, ownership, evidence trails, and MCP-readable repo context.
automation-workspace	Recurring agent or script automation with runbooks, records, and evals.

See the generated Profile Reference for the current profile metadata from generator/profiles/*.yml.

Config Files

Use --config for repeatable workspace definitions. The schema accepts name, slug, output, profile, description, owner, visibility, repoType, workspaceType, workspaceStatus, workspaceSlug, packageManager, updatedAt, features, services, and the boolean generation controls.

Flags override config values, which lets agents keep a stable template while changing the output directory or owner for a specific run.

Verify Generator Changes

npm run test:create-index
node generator/create-index.mjs --help

Use --dry-run when you need to inspect the file plan before writing a workspace.

The generated CLI Reference is refreshed by npm run docs:generate and checked by npm run docs:check.