Command Line Tool

The compass command line tool is used to setup and compile your project’s sass files.

The command line tool has changed significantly with the release of version 0.10.0.

Project Commands

Create a new compass project

compass create path/to/project [--using blueprint] [--sass-dir=sass ...] [--project-type=rails]

Initialize an existing project to work with compass

compass init rails path/to/project [--using blueprint]

Install a pattern from an extension into a project

compass install blueprint/buttons [path/to/project]

Compile the project’s sass files into css

compass compile [path/to/project]

Watch the project for changes and compile whenever it does

compass watch [path/to/project]

Emit a configuration file at the location specified.

compass config [path/to/config] [--sass-dir=sass --css-dir=css ...]

Validate the generated CSS.

compass validate [path/to/project]

Misc commands

Generate a background image that can be used to verify grid alignment

compass grid-img W+GxH [path/to/grid.png]

Enter into a console for testing SassScript in a compass environment.

compass interactive

Print out statistics about your stylesheets

compass stats

Emit the version of compass

compass version

Get Help on the Command Line

Get help on compass

compass help

Get help on an extension

compass help extension_name

Get help about an extension pattern

compass help extension_name/pattern_name

Get help about a particular sub command

compass help command_name