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 Native theme builder in your browser. Use it to customize your design system and generate a unique preset ID.

buridan create

init

Initialize Buridan Native 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 Native 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-0.0.1.tar.gz (1.4 MB view details)

Uploaded Source

Built Distribution

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

buridan-0.0.1-py3-none-any.whl (246.1 kB view details)

Uploaded Python 3

File details

Details for the file buridan-0.0.1.tar.gz.

File metadata

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

File hashes

Hashes for buridan-0.0.1.tar.gz
Algorithm Hash digest
SHA256 d9a805730686faebb5eae2f6cf0fb9925e8be09b36684b23ead17836a5307f95
MD5 58a26c54af4a2b06c759cb4e0a2d20fe
BLAKE2b-256 a0a737fa71fc98e6828068be088d5aafdedf526d869351a14f54609ac89b2364

See more details on using hashes here.

File details

Details for the file buridan-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: buridan-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 246.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.7

File hashes

Hashes for buridan-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e8c5636ca2fa7f71319aebcc1cd570b0dc892c1a7f969d9d8131800a20776143
MD5 dfeab6bebc25a7d22f534afcc267093e
BLAKE2b-256 557f674b5338f31d7d9b1c77dba4493f501f2fa503d72fb75881b64a14ac11dd

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