roots
- a toolkit for quickly building beautiful websites
roots new <name>
--template
roots template <command>
roots compile
--no-compress
roots watch
roots deploy
name --service
roots clean
roots version
roots pkg
command
roots plugin
command
Roots exposes a variety of commands for creating, managing, compiling, and deploying websites. Commands are listed and documented below.
new
, <name>
, --template
create a new roots project called name.
templates:
- default (jade, stylus, coffeescript) - default
- ejs (ejs, stylus, coffeescript)
- min (default stack, no comments and uses jade layouts)
- basic (html, css, javascript, no layouts)
- blog (blog example optimized for dynamic content)
template
, <command>
manage roots project templates.
commands:
- add, <name> <git-url> (git clone will download the template)
- remove, <name> (be careful with this)
- default, <name> (sets a template to be the default for roots new)
compile
, --no-compress
compile, compress, and minify the project to public
, adding the option no-compress will bypass the compression.
watch
watch your project and compile/reload whenever a file is saved. does not work for roots-express or roots-rails.
deploy
, name, --service
configure, compile, commit, and deploy your project. name optional for heroku.
services:
- heroku - default
- nodejitsu
- gh-pages
clean
remove the compiled files.
version
print the version of the current roots install.
pkg
, <command>
exposes a package manager's interface. type roots pkg
to display the package manager's options. any command given after pkg
is delegated to the package manager.
package managers:
- bower (http://bower.io) - default
- cdnjs (https://github.com/jenius/cli-js)
you can change your package manager via the ~/.rootsrc
file.
plugin
, <command>
manages plugins (user-generated roots compilers).
commands:
- generate --js (optional, generates a javascript template rather than coffeescript)
- install <username>/<repo> (must provide a username/repo on github)
Full docs can be found at http://roots.cx