Skip to main content

​
Package managers

Install rbx-css using your preferred package manager: 
npm install rbx-css
This installs the rbx-css CLI globally in your project, making it available for compilation commands.

​
Verify installation

After installation, verify that rbx-css is working correctly: 
npx rbx-css --version
You should see the version number (e.g., 0.1.0).

​
Requirements

rbx-css requires Node.js 16 or higher, or Bun 1.0 or higher.
The package has minimal dependencies:
  • commander - CLI framework
  • lightningcss - Fast CSS parser and transformer

​
Development setup

If you’re developing rbx-css itself or want to run it from source:
1

Clone the repository

git clone https://github.com/your-org/rbx-css.git
cd rbx-css
2

Install dependencies

bun install
3

Build the project

bun run build
4

Run from source

bun run dev compile styles.css

​
Project structure

After installation, you’ll typically organize your project like this: 
your-project/
├── src/
│   ├── styles/
│   │   ├── base.css
│   │   ├── components.css
│   │   └── theme.css
│   └── ...
├── out/
│   └── StyleSheet.luau
├── package.json
└── ...
Keep your CSS files organized in a dedicated styles/ directory for easier management.

​
Editor setup

​
VS Code

For the best development experience in VS Code:
  1. Install the CSS Language Features extension (built-in)
  2. Enable CSS IntelliSense for autocomplete and validation
  3. Optionally install Lightning CSS for enhanced CSS support

​
Other editors

rbx-css uses standard CSS syntax, so any editor with CSS support will work:
  • Sublime Text: Built-in CSS support
  • Neovim: Use css-lsp or tailwindcss-intellisense
  • WebStorm: Built-in CSS support

​
Next steps

Quick start guide

Create your first StyleSheet in minutes

CLI reference

Learn all CLI commands and options

Build docs developers (and LLMs) love

Get started for freeTalk to us