CLI reference

All commands are run as bluprint <command>.

new [name]

Scaffold a starter bluprint.config.ts in the current directory, turning the repo into a bluprint. Prompts for a name if none is given; refuses if a config already exists.

bluprint new "My bluprint"

preview [path]

Scaffold a local bluprint (default: the current directory) into a temp directory and run its actions, for testing before publishing. Prints the output path. See Previewing.

bluprint preview

add [repo]

Register a bluprint with your CLI by its GitHub repo (URL, SSH string, or user/repo). Prompts if no repo is given.

bluprint add reuters-graphics/my-bluprint

start [bluprint]

Scaffold a new project into the current directory from a registered bluprint or any GitHub repo. Prompts you to pick one — and to pick a part, if the bluprint defines them — then runs its actions.

bluprint start
bluprint start reuters-graphics/my-bluprint

Option	Description
--input <file>	JSON file of answers for the bluprint’s prompt actions, keyed by prompt name.
--part <key>	Scaffold a specific part instead of the whole bluprint.
--ci	Run non-interactively (also auto-detected when stdin isn’t a TTY or CI is set).

In non-interactive mode start never prompts: prompt answers come from --input (falling back to each prompt’s initialValue), the part comes from --part, and any action failure aborts with a non-zero exit so a CI run can’t pass silently. See Scaffolding in CI.

bluprint start reuters-graphics/my-bluprint --input answers.json --ci

clone <repo>

Copy a git repo’s files into the current directory verbatim — no part selection, no actions, config file kept. Works with any repo, not just bluprints.

bluprint clone reuters-graphics/some-repo

remove [bluprint]

Unregister a bluprint from your CLI. Prompts from your registered list if no name is given.

bluprint remove

token [accessToken]

Save a GitHub personal access token to your CLI profile (~/.bluprint) so the CLI can read private repos. Prompts if no token is given. You can also set the GITHUB_TOKEN environment variable instead.

bluprint token <your token>