Skip to main content

A command line interface (CLI) for adding components and themes to your project.

Project description

buridan

A command line interface (CLI) for adding components and themes to your project.

create

Opens the Buridan UI theme builder in your browser. Use it to customize your design system and generate a unique preset ID.

buridan create

init

Initialize Buridan UI in your project. This command sets up CSS utilities (shimmer, scroll fade) in assets/globals.css and updates rxconfig.py with the required Tailwind configuration.

buridan init

apply

Apply a theme preset to your project. Generates :root and .dark CSS variable blocks in assets/globals.css based on the preset ID from the theme builder.

buridan apply --preset <ID>

Arguments:

  • --preset: The theme preset ID from the Buridan UI theme builder. Use b0 for the default theme.

Example:

buridan apply --preset b0
buridan apply --preset b2D0wqNxT

add

Add components and their dependencies to your project.

buridan add <name>

You can add multiple components at once:

buridan add button input select

Blocks (charts, dashboards, etc.) can be added the same way:

buridan add line_chart_01

Components are placed in components/, blocks in blocks/. Dependencies are resolved and added automatically.

Note: Components require a theme to render correctly. Run buridan apply before using components.

list

Display all available components and blocks.

buridan list

Recommended workflow

buridan create                    # build your theme, copy the preset ID
buridan init                      # set up utilities and Tailwind config
buridan apply --preset <ID>       # apply your theme
buridan add button input select   # add the components you need

Documentation

Visit https://ui.buridan.dev/components to see all the components.

Visit https://ui.buridan.dev/docs/getting-started/cli section to get started.

License

Licensed under the MIT license

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

buridan_create-0.1.20.tar.gz (2.1 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

buridan_create-0.1.20-py3-none-any.whl (329.4 kB view details)

Uploaded Python 3

File details

Details for the file buridan_create-0.1.20.tar.gz.

File metadata

  • Download URL: buridan_create-0.1.20.tar.gz
  • Upload date:
  • Size: 2.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.7

File hashes

Hashes for buridan_create-0.1.20.tar.gz
Algorithm Hash digest
SHA256 871fdf12e60348b07a84ae9a1974ca71758fd64c04f171a0662cc76dc136fcbc
MD5 47f39b820a80cff5ec2bbe954a3698e8
BLAKE2b-256 81b9f98fc61dd80b6ce2d0d0a6797ab2ac64dafe442637e0967393bdcb1cd797

See more details on using hashes here.

File details

Details for the file buridan_create-0.1.20-py3-none-any.whl.

File metadata

File hashes

Hashes for buridan_create-0.1.20-py3-none-any.whl
Algorithm Hash digest
SHA256 cb3ba69bf548254b602a1cb0ae10e7af9b0ea8ff19c95fd108128923ed9a5837
MD5 e7d374efd1867c80c7e4133e1356c8e6
BLAKE2b-256 646a09de4bb62d0d8a5fade8b68c3dc09a719dbc99c4e824c41c7441ce4cdb26

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page