nodecg-cli

nodecg-cli

NodeCG's command line interface.

❗ WARNING: As of NodeCG v2, nodecg-cli versions earlier than v8.6.1 are no longer supported and will fail to install NodeCG v2 or greater. Please upgrade your installation of nodecg-cli by running npm install -g nodecg-cli@latest.

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.
• nodecg schema-types [dir], Generate d.ts TypeScript typedef files from Replicant schemas and configschema.json (if present)

Special Thanks

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

Changelog

8.6.8 (2023-06-20)

Bug Fixes

• try prepending "v" to the checkout tag when installing a bundle (58daa03)