CLI
Installation
Global
npm install -g nodecg
In project
npm install -D nodecg
Commands
nodecg setup [version]
mkdir nodecg
cd nodecg
nodecg setup
Options
| Name | Description |
|---|---|
version | The semver version to install. If none then latest will be installed |
--update -u | Install over an existing copy of NodeCG |
--skip-dependencies -k | Skip installing dependencies |
nodecg start
Start the NodeCG instance in this directory path.
Options
| Name | Description |
|---|---|
--disable-source-maps -d | Disable source map support |
nodecg install [repo]
Install a bundle by cloning a git repo and installing its production dependencies. If run in a bundle directory with no arguments, installs that bundle's dependencies.
nodecg install username/repository
Options
| Name | Description |
|---|---|
repo | A GitHub owner/repo pair or https git url |
--dev -d | Install the bundle's devDependencies |
nodecg uninstall [bundle]
Uninstalls a bundle.
Options
| Name | Description |
|---|---|
bundle | The bundle's name |
--force -f | Ignores warnings |
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)
Options
| Name | Default | Description |
|---|---|---|
dir | schemas | The directory where the replicant schemas are located |
--out-dir [path] -o | src/types/schemas | Where to put the generated d.ts files |
--no-config-schema | Don't generate a typedef from configschema.json |