bog-cli

1.0.1 verified Sat Apr 25 auth: no javascript

bog-cli is a command-line interface tool for managing Bits of Good internal tools and design system integrations. Current stable version is 1.0.1, released on npm. It allows initializing a design system in React/Next.js projects with options to install Tailwind V4, dependencies, global stylesheets, and fonts. It also provides a unified command to add, update, or remove design system components interactively. The package ships TypeScript types and requires Node.js >=18.

Common errors

error npx: command not found: bog ↓

cause The bog-cli package is not installed globally or the command is not available.

fix

Run 'npm install -g bog-cli' or use 'npx bog-cli' instead of 'bog'.

error Error: Cannot find module 'bog-cli' ↓

cause The package is not installed in the current project.

fix

Run 'npm install bog-cli' in your project directory.

Warnings

gotcha The CLI requires Node.js >=18. Using older versions will fail. ↓

fix Update Node.js to version 18 or later.

gotcha Commands are intended to be run via npx bog, not direct require/import. Programmatic API is limited. ↓

fix Use npx bog <command> for intended usage.

Install

npm install bog-cli

yarn add bog-cli

pnpm add bog-cli

Imports

default
```
import bog from 'bog-cli'
```
Default import for programmatic usage; CLI is primarily used via npx.

BogConfig

wrong

const { BogConfig } = require('bog-cli')

correct

import { BogConfig } from 'bog-cli'

TypeScript type/interface, only available with ESM import.

Quickstart

Initializes the Bits of Good design system in a React/Next.js project using npx bog.

#!/usr/bin/env node
import { execSync } from 'node:child_process';
execSync('npx bog design init', { stdio: 'inherit' });