v2.0 is here! New components and themes are coming soon! Stay tuned.
TWJ Labs UI

_CLI

Command Line Interface for twjlabs/ui

Overview

The twjlabs/ui CLI is a powerful tool that simplifies the process of integrating the twjlabs/ui component library into your projects. With just a few commands, you can set up your development environment, install necessary dependencies, and scaffold out components with ease.

Initialization

To get started with the twjlabs/ui CLI, you first need to initialize it in your project. Open your terminal and navigate to your project directory, then run the following command:

npx @twjlabs/ui init
pnpm dlx @twjlabs/ui init

This command will set up the basic configuration files and folder structure needed for twjlabs/ui to function properly in your project.

Adding Components

Once you have initialized the CLI, you can easily add components to your project. To add a specific component, use the following command:

npx @twjlabs/ui add <component-name>
pnpm dlx @twjlabs/ui add <component-name>

Replace <component-name> with the name of the component you wish to add, such as button, dropdown-menu, or navbar. The CLI will handle the installation and setup for you.

Additional Commands

The twjlabs/ui CLI also offers several other useful commands to enhance your development workflow:

  • npx @twjlabs/ui update: Updates all twjlabs/ui components to their latest versions.
  • npx @twjlabs/ui remove <component-name>: Removes a specified component from your project.
  • npx @twjlabs/ui list: Lists all available twjlabs/ui components that you can add to your project.

On this page