Quickstart

Install

Install bluprint globally with your preferred package manager:

pnpm add -g @reuters-graphics/bluprint

npm install -g @reuters-graphics/bluprint

Create a bluprint

Any repo becomes a bluprint when you add a bluprint.config.ts to its root. In the project you want to templatize, run:

bluprint new

That scaffolds a starter config:

import { defineConfig } from '@reuters-graphics/bluprint';

export default defineConfig({
  name: 'My bluprint',
  bluprint: '^1.0.0',
  files: ['**/*'],
  ignores: [],
  actions: [],
});

files / ignores decide which of the repo’s files get scaffolded.
actions transform those files after they’re copied — see the Actions guide.

See Creating a bluprint for every option.

Preview it locally

Before publishing, test your bluprint straight from your working directory:

bluprint preview

This scaffolds your current files into a temp directory, runs your actions, and prints the path so you can inspect exactly what a user would get — no publishing required. See Previewing.

Publish

Commit bluprint.config.ts and push to GitHub. That’s it — there’s no separate publish step; the CLI pulls straight from the repo.

Use it

bluprint add reuters-graphics/my-bluprint

A repo can be referenced by URL (https://github.com/user/repo), SSH string (git@github.com:user/repo.git), or the user/repo shorthand.

Then scaffold a new project from it in an empty directory:

bluprint start

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

Private repositories

To let the CLI read a private repo, provide a personal access token one of two ways:

export GITHUB_TOKEN=<your token>   # environment variable

bluprint token <your token>        # saved to your CLI profile

Next steps

Create a bluprint — every config option
Actions — transform scaffolded files
Parts — reusable segments
Previewing — test locally as you build