Installing NodeCG


There are two methods to install NodeCG: cloning from GitHub or using the nodecg-cli.

Install Node.js (version 8.3 or greater) & npm (version 2 or greater).

Using nodecg-cli:

npm install --global nodecg-cli
mkdir nodecg
cd nodecg
nodecg setup

Cloning from GitHub:

git clone --branch legacy-1.x
cd nodecg
npm install --production

Ensure to specify a branch when cloning, as the master branch is in an unstable state while v2.0 is being developed.


Run node index.js or nodecg start in the root nodecg folder.

Open the dashboard (http://localhost:9090 by default).


When running NodeCG in production, Docker or pm2 are recommended.

Installing bundles

NodeCG's individual graphics packages are called bundles. They can be installed either from the command-line (via nodecg-cli), or by simply placing the folder into the ./bundles directory.

The easiest way to install bundles is via the command-line using nodecg-cli. You will need to install nodecg-cli before you can use the nodecg terminal commands.


nodecg install lange/lange-notify


nodecg install bitbucket:username/repo-name

Other Providers

Enter the git URL.

nodecg install

Bundles are just directories inside the ./bundles folder. They can always be added and removed by simply moving them into or out of that folder. Avoid installing or uninstalling bundles while NodeCG is running.

Last updated on by zoton2