-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Command Line Tool
chriseppstein edited this page Sep 13, 2010
·
12 revisions
$ ./bin/compass -h
Usage: compass [options] [project]
Description:
When project is given, generates a new project of that name as a subdirectory of
the current directory.
If you change any source files, you can update your project using --update.
Options:
-u, --update Update the current project
-w, --watch Monitor the current project for changes and update
-f, --framework FRAMEWORK Use the specified framework.
-p, --pattern PATTERN Stamp out a pattern into the current project. Must be used in combination with -f.
-n, --pattern-name NAME The name to use when stamping a pattern. Must be used in combination with -p.
--sass-dir SRC_DIR The source directory where you keep your sass stylesheets.
--css-dir CSS_DIR The target directory where you keep your css stylesheets.
--list-frameworks List compass frameworks available to use.
-c, --write-configuration Write the current configuration to the configuration file.
-e, --environment ENV Use sensible defaults for your current environment: development, production (default)
-s, --output-style STYLE Select a CSS output mode (nested, expanded, compact, compressed)
-r, --require LIBRARY Require LIBRARY before running commands. This is used to access compass plugins.
--rails Sets the project type to a rails project.
-q, --quiet Quiet mode.
--dry-run Dry Run. Tells you what it plans to do.
--trace Show a full stacktrace on error
--force Force. Allows some commands to succeed when they would otherwise fail.
--imports Emit an import path suitable for use with the Sass command-line tool.
--validate Validate your project's compiled css. Requires Java.
--grid-img [DIMENSIONS] Generate a background image to test grid alignment. Dimension is given as <column_width>+<gutter_width>. Defaults to 30+10.
-?, -h, --help Show this message
-v, --version Print version