starui

Installation

How to install and set up StarUI in your project.

Get started with StarUI in minutes. Build beautiful, accessible components with Python and StarHTML.

Quick Start

Import and use components in your app

from components.ui.button import Button

Button("Get Started")
Button("View Components", variant="outline")

Installation

1

Install the StarUI CLI

Install StarUI globally using pip to access the CLI commands.

pip install starui
2

Initialize your project

Set up StarUI in your project directory. This creates the configuration and installs dependencies.

star init

Creates starui.json configuration file

Configures component paths and settings

Installs required dependencies

StarHTML, Tailwind CSS, and component utilities

3

Add components to your project

Install individual components with their dependencies automatically resolved.

# Add a single component
star add button

# Add multiple components at once
star add button input card tabs

# List all available components
star list

Usage Examples

Basic Component Usage

Import and use components from your local project

Interactive Components

Add reactivity using Datastar for dynamic user interfaces

Clicked: