# scarab-cli

[![npm](https://img.shields.io/npm/v/scarab-cli.svg)](https://www.npmjs.com/package/scarab-cli) [![Build Status](https://travis-ci.org/watchtowerdigital/scarab-cli.svg?branch=master)](https://travis-ci.org/watchtowerdigital/scarab-cli) 

**Command-line interface for the Scarab Sass framework**



## Installation
Install `scarab-cli` globally via npm:
```
npm install scarab-cli -g
```



## Usage

```
Usage: scarab [options] [command]


Commands:

  view [options] [keys...]          View Scarab configuration in the terminal
  export <file> [outputDir]         Export Scarab configuration from .scss to .json
  init [outputDir]                  Scaffold Scarab config folders and files
  styleguide [options] [outputDir]  Scaffold a scarab-styleguide project

Options:

  -h, --help     output usage information
  -V, --version  output the version number
```



## Documentation
Documentation is a work-in-progress.



## Related
* [**scarab-scss**](https://github.com/watchtowerdigital/scarab.git) — Sass utility framework for rapid stylesheet development
* [**scarab-carapace**](https://github.com/watchtowerdigital/scarab-carapace.git) — Highly configurable framework for generating functional CSS classes
* [**scarab-styleguide**](https://github.com/watchtowerdigital/scarab-styleguide.git) — Generate automatic styleguides from scarab-carapace configuration
* [**scarab-snippets**](https://github.com/watchtowerdigital/scarab-snippets.git) — Sublime Text snippets for the Scarab Sass utility framework