Skip to content

Using bluprints

Once you’ve registered a bluprint, you can scaffold projects from it.

Register a bluprint

Section titled “Register a bluprint”

Add a bluprint to your CLI by its GitHub repo:

Terminal window
bluprint add reuters-graphics/my-bluprint

The repo can be a URL, an SSH string, or the user/repo shorthand. Run add with no argument to be prompted.

Start a new project

Section titled “Start a new project”

In an empty directory, run:

Terminal window
bluprint start

The CLI lists your registered bluprints, downloads the chosen one, scaffolds its files, and runs its actions — prompting you for anything they need.

You can also pass a bluprint directly — a registered name, or any GitHub repo:

Terminal window
bluprint start reuters-graphics/my-bluprint

If the bluprint has parts, you’ll be asked whether to scaffold the whole thing or just one part.

Clone a repo

Section titled “Clone a repo”

To copy a repo’s files into the current directory without running any bluprint actions — even a repo that isn’t a bluprint:

Terminal window
bluprint clone reuters-graphics/some-repo

Unlike start, clone copies the whole repo verbatim (including any bluprint.config.ts) and never runs actions or part selection.

Remove a bluprint

Section titled “Remove a bluprint”
Terminal window
bluprint remove

Pick from your registered bluprints, or pass a name to remove it directly.

Private repositories

Section titled “Private repositories”

Give the CLI access to private repos with a personal access token:

Terminal window
export GITHUB_TOKEN=<your token>   # environment variable
Terminal window
bluprint token <your token>        # saved to your CLI profile (~/.bluprint)

Upgrading from a pre-1.0 version

Section titled “Upgrading from a pre-1.0 version”

Nothing to do — on its first run, bluprint automatically imports your old ~/.bluprintrc (registered bluprints and token) into the new profile at ~/.bluprint.