CLI Reference

Generated from node generator/create-index.mjs --help by npm run docs:generate.

create-index generates an Index workspace from deterministic CLI arguments. It is non-interactive by default, so agents should gather missing facts first and then run one complete command.

Usage

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

Required Options

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. Default: public-template.
--features <list>	Comma-separated features to include.
--owner <name>	Owning team or organization.
--visibility <value>	public, internal, or private. Default: 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. Default: 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.

Full Help Output

create-index

Generate an index-style repository from deterministic CLI arguments.

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

Required:
  --name <name>              Human-facing repository or workspace name.
  --output <path>            Directory to create.

Common options:
  --slug <slug>              Machine slug. Defaults to a slugified --name.
  --profile <name>           Profile from generator/profiles. Default: public-template.
  --features <list>          Comma-separated features to include.
  --owner <name>             Owning team or organization.
  --visibility <value>       public, internal, or private. Default: 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. Default: 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.

The CLI is non-interactive by default. Use prompts/create-index.md to ask missing
setup questions first, then run one complete command.