Skip to content

Installation

github-actions[bot] edited this page Apr 8, 2026 · 2 revisions

Installation

Bluetemberg is published to the GitHub Packages npm registry under @prototypdigital/bluetemberg.

Prerequisites

  • Node.js >= 18
  • npm, pnpm, or yarn
  • GitHub account with access to the prototypdigital organization

1. Authenticate with GitHub Packages

Create or add to your project's .npmrc:

@prototypdigital:registry=https://npm.pkg.github.com
//npm.pkg.github.com/:_authToken=${GITHUB_TOKEN}

Set the GITHUB_TOKEN environment variable to a personal access token (classic) with read:packages scope, or a fine-grained token with Packages read permission.

For CI environments, use the built-in GITHUB_TOKEN secret.

2. Install

Option A: Run directly with npx

npx @prototypdigital/bluetemberg init

Option B: Install as a dev dependency

npm install -D @prototypdigital/bluetemberg
# or
pnpm add -D @prototypdigital/bluetemberg

Then use via package scripts:

npx bluetemberg init
npx bluetemberg sync

CI authentication

In GitHub Actions, add the registry setup to your workflow:

- uses: actions/setup-node@v4
  with:
    node-version: '20'
    registry-url: 'https://npm.pkg.github.com'
    scope: '@prototypdigital'
  env:
    NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Clone this wiki locally