@roots/bud-cli

👩‍💻 The @roots/bud CLI runner utility

Installation
Getting started
bud build
bud extensions
Running the build with logging
Installing dependencies automatically
Running the build in CI
Exiting the CLI from dev mode
Contributing
Bud sponsors
Community

Installation

With yarn.

yarn add @roots/bud-cli --dev

With npm:

npm install @roots/bud-cli --save-dev

Getting started

The CLI includes detailed usage instructions:

yarn bud --help

bud build

Compile assets for production:

bud build

Compile assets for development:

bud build:dev

bud extensions

List installed extensions:

bud extensions:list

Install extension dependencies:

bud extensions:install

Running the build with logging

Use the --log flag to run the build with logging enabled.

Installing dependencies automatically

Try the --install flag to install packages flagged as required by various extensions.

Running the build in CI

It is possible, depending on your environment, that Bud's CLI output causes issues. In particular, it's usage of tty raw mode can cause issues in CI.

To run the build but not use the @roots/bud-cli renderer, there is a --ci flag which indicates you want to run the build for these environments.