bog-cli

This is the repository for Bits of Good's internal CLI used to manage integrations with internal tools to our applications.

Setup

If you want to use this CLI in your project, run npm i bog-cli. You can then access all of the commands below prefixed with npx bog (for example, npx bog design init)

Dev Setup

After cloning this repository locally, install the necessary packages using npm i. This sets up the project locally, but to run commands, follow the steps below.

Running/Testing Commands Using a Local Build

To run commands based on your local code, run the following commands:

npm run dev
npm run link

When you are making changes to the CLI, it is recommended to have npm run dev running in the background as it can watch for your changes actively.

To run commands, use the bog command. For example, bog design init will run the design system init command below.

Supported Commands

These are the current commands this CLI supports. All commands support the -h/--help flags.

• design
  • init: Initializes the design system in an existing React/Next.js project. This command gives you the option to install Tailwind V4, the dependencies for the design system, our global stylesheet containing our theme, and our fonts directly into your project.
  • edit: Manages design system components in your project. This unified command allows you to add new components, update existing components to the latest version, or remove components from your project. It provides an interactive interface to select which components to add, update, or remove.