Installation

All Cubitt packages are published as private GitHub Packages under the @tilt-legal scope. You'll need to authenticate to install them.

Generate GitHub Token

Go to GitHub → Settings → Developer Settings → Personal Access Tokens
Create a new token with read:packages scope
Copy the token (starts with ghp_...)

Configure `.npmrc`

Create .npmrc in your project root and commit it to your repository:

@tilt-legal:registry=https://npm.pkg.github.com
//npm.pkg.github.com/:_authToken=${GH_NPM_TOKEN}

An .npmrc file is required by Vercel/CI to locate and authenticate with the package registry. Installing packages will fail without it.

Only commit the .npmrc file if it uses environment variables. Never commit a file containing actual tokens.

Set Environment Variable

To permanently set the environment variable, add it to your .zshrc or .bashrc file.

export GH_NPM_TOKEN=ghp_your_token_here

GH_NPM_TOKEN is already set in the Vercel environment variables for the Tilt Legal team. This means any project in the Tilt Legal team will be able to install Cubitt packages automatically during build time.

Install Cubitt Packages

pnpm add @tilt-legal/cubitt-icons @tilt-legal/cubitt-components @tilt-legal/cubitt-logos

After install, see Imports and Namespaces for the canonical import paths for components, icons, and logos.

Configure TanStack Router URL State

If you plan to use Cubitt's built-in URL state props, follow the URL State Management Guide to ensure your app is wrapped in RouterProvider and your router registration is available for type-safe paramName keys.