NodeCG's command line interface. https://github.com/nodecg/nodecg
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin refactor: port to ES6 Feb 15, 2017
commands
lib refactor: port to ES6 Feb 15, 2017
test
.editorconfig
.eslintignore test: maybe fix tests on travis Feb 15, 2017
.eslintrc
.gitattributes
.gitignore
.travis.yml
AUTHORS it works 🙆 Jan 16, 2015
CHANGELOG.md
CONTRIBUTING.md docs(contribution): add contribution guidelines Feb 18, 2016
LICENSE
README.md docs(readme): add Greenkeeper badge (#35) Feb 12, 2017
index.js
package.json

README.md

nodecg-cli

NodeCG's command line interface.

Build Status Coverage Status Greenkeeper badge

Installation

First, make sure you have git installed, and that it is in your PATH. Then, install bower, which may be used to install bundles' dependencies:

npm install -g bower

Once those are installed, you may install nodecg-cli via npm:

npm install -g nodecg-cli

Installing nodecg-cli does not install NodeCG. To install an instance of NodeCG, use the setup command in an empty directory:

mkdir nodecg
cd nodecg
nodecg setup

Usage

  • nodecg setup [version] [--update], install a new instance of NodeCG. version is a semver range. If version is not supplied, the latest release will be installed. Enable --update flag to install over an existing copy of NodeCG.
  • nodecg start, start the NodeCG instance in this directory path
  • nodecg install [repo] [--dev], install a bundle by cloning a git repo. Can be a GitHub owner/repo pair (supportclass/lfg-sublistener) or https git url (https://github.com/SupportClass/lfg-sublistener.git). If run in a bundle directory with no arguments, installs that bundle's dependencies. Enable --dev flag to install the bundle's devDependencies.
  • nodecg uninstall <bundle>, uninstall a bundle
  • nodecg defaultconfig, If a bundle has a configschema.json present in its root, this command will create a default config file at nodecg/cfg/:bundleName.json with defaults based on that schema.

Special Thanks

This CLI program is based on Tim Santeford's commander.js starter.