CLI

Vireo CLI

Create projects and manage generated capabilities with the two executables published by create-vireo.

The public create-vireo package exposes two executables with different jobs.

create-vireo#

Use the create executable through npm to produce a new project from the pinned golden-path template:

bash
npm create vireo@latest my-app
npm create vireo@latest my-ui -- --profile frontend

Creation is atomic: the destination is not presented as complete until the projection and metadata are valid.

vireo#

Generated projects pin the application-development CLI through their vireo npm script:

bash
corepack npm run vireo -- generate entity schema.json
corepack npm run vireo -- check
corepack npm run vireo -- eject entity-plural
corepack npm run vireo -- upgrade --to VERSION
corepack npm run vireo -- remove-example --dry-run

Project scripts versus CLI commands#

setup, dev, doctor and verify are project scripts. generate, check, eject, remove-example and upgrade are Vireo CLI commands. remove-example is non-writing by default, exposes --status, and requires --apply after its ownership checks pass. This distinction lets diagnostics and runtime composition vary by profile without expanding the global CLI surface.

Machine-readable output#

Generation and checking support --json where automation needs structured output. Human output remains optimized for review and includes the next safe command.

Continue with Doctor diagnostics, Entity generation or Project upgrades.

Start typing to search the current Vireo documentation.