Getting Started
Before you start
- Node.js 18+ recommended
- A valid license key from your typeui.sh purchase via Polar
Install and run
Use the published CLI (recommended for end users):
npx typeui.sh --help
Or if the package is already installed globally:
typeui.sh --help
Available commands
The two most important commands for the CLI are:
npx typeui.sh generatenpx typeui.sh update
The generate command will walk you through a series of questions and options that will create a custom design system guideline per Projects
Additionally, the update command allows you to hand pick each setting and update the accordingly.