THIS REPOSITORY MOVED TO https://github.com/pattern-lab/patternlab-node/tree/dev/packages/cli

PatternLab Node CLI

Command-line interface (CLI) for the patternlab-node core.

Installation

Note: Global installs are currently not supported and will be fixed when the Pattern Lab core hits v3.0.0

Via NPM

npm install pattern-lab/patternlab-node-cli --save-dev

Via Yarn

yarn add pattern-lab/patternlab-node-cli --dev

Getting Started

1. In order to use PatternLab you need to initialize a PatternLab project with patternlab init. The CLI will ask you some setup question and scaffold your project based on it.
2. Build your patterns use patternlab build. The PatternLab CLI will assume that the patternlab-config.json is in the project root. Othewise specify a custom path to config with patternlab build --config path/to/config
3. To view your patterns in the browser preview patternlab serve or again specify a custom config location patternlab serve --config path/to/config
4. To export your patterns in the browser preview patternlab export or again specify a custom config location patternlab export --config path/to/config

API & Usage

General usage

Usage: patternlab <cmd> [options]
Commands:
build|compile [options] Build the PatternLab. Optionally (re-)build only the patterns
export Export a PatternLab patterns into a compressed format
init [options] Initialize a PatternLab project from scratch or import an edition and/or starterkit
install|add [options] Installs Pattern Lab related modules like starterkits or plugins
serve|browse [options] Starts a server to inspect files in browser
Options:
-h, --help output usage information
-V, --version output the version number
-c, --config <path> Specify config file. Default looks up the project dir
-v, --verbose Show verbose logging
--silent Turn off console logs

Build/Compile PatternLab

Usage: build|compile [options]
Build the PatternLab. Optionally (re-)build only the patterns
Options:
-h, --help output usage information
-p, --patterns-only Whether to only build patterns

Initialize PatternLab

Usage: init [options]
Initialize a PatternLab project from scratch or import an edition and/or starterkit
Passing no options starts the init in interactive mode
Options:
-h, --help output usage information
-p, --project-dir <path> Specify a project directory. Default: ./
-e, --edition <name> Specify an edition to install. Default: edition-node
-k, --starterkit <name> Specify a starterkit to install. Default: starterkit-mustache-base

Serve PatternLab

Usage: serve|browse [options]
Starts a server to inspect files in browser
Options:
-h, --help output usage information
-w, --watch Start watching for changes

Export PatternLab

Usage: export [options]
Export a PatternLab patterns into a compressed format
Options:
-h, --help output usage information

Install Pattern Lab starterkits or plugins

Usage: install|add [options]
Installs Pattern Lab related modules like starterkits or plugins
Options:
-h, --help output usage information
--starterkits <names> Specify one or more starterkits to install
--plugins <names> Specify one or more plugins to install

Examples

 $ patternlab init # Initialize a PatternLab project.
$ patternlab build # Builds PatternLab from the current dir
$ patternlab build --config <path/to/patternlab-config> # Builds PatternLab from different project directory

License

MIT © Raphael Okon