Installation

Install chirp-ui using pip or uv

Page actions AI-ready formats and sharing
Open LLM text
Share with AI
Ask Claude Ask ChatGPT Ask Gemini Ask Copilot

Requirements

Prerequisites

0/2 complete
  • Python 3.14+ installed
  • Chirp installed (for full integration) or Kida (for standalone use)

Install

uv add chirp-ui

pip install chirp-ui

uv add "bengal-chirp[ui]"
# or
pip install "bengal-chirp[ui]"

Verify Installation

import chirp_ui
print(chirp_ui.__version__)  # e.g. "0.11.0"

Apply the chirp-theme Bengal Theme

The samechirp-uipackage also ships chirp-theme, a static-first Bengal theme. If you build a documentation or marketing site with Bengal, you can adopt the theme without a separate install —uv add chirp-uiregisters it through the bengal.themes entry point (chirp-theme = "bengal_themes.chirp_theme").

Theme prerequisites

0/2 complete
  • Bengal >=0.3.3 (needed forlibrary_asset_tags(), which links the bundledchirpui.css)
  • chirp-ui installed (brings the theme via its bengal.themesentry point)

Point your Bengal site config at the theme by settingtheme.name:

# config/_default/theme.yaml  (or the theme block in bengal.toml)
theme:
  name: "chirp-theme"

Then build and serve the site:

uv run bengal build
uv run bengal serve

Why Bengal >=0.3.3? chirp-theme'sbase.htmlcalls library_asset_tags() to inject the component library's chirpui.css. That hook lands in Bengal 0.3.3. On older Bengal the call is skipped and the base CSS never loads, so spacing and grid layout collapse in the footer and top bar. Pinbengal>=0.3.3to be safe.

For the theme's architecture, ownership model, and parity policy, see [chirp-theme].

Next Steps

  • [Apply chirp-theme] — Adopt the static-first Bengal theme on your own site
  • [Components] — Browse layout, UI, forms, and streaming components
  • [Theming] — Customize with CSS variables
  • [App Shell] — Build dashboard layouts with sidebar and breadcrumbs