Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nodecg/nodecg-cli
NodeCG's command line interface. https://github.com/nodecg/nodecg
https://github.com/nodecg/nodecg-cli
Last synced: about 14 hours ago
JSON representation
NodeCG's command line interface. https://github.com/nodecg/nodecg
- Host: GitHub
- URL: https://github.com/nodecg/nodecg-cli
- Owner: nodecg
- Created: 2015-01-16T18:34:40.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2023-06-20T22:57:50.000Z (over 1 year ago)
- Last Synced: 2024-06-19T01:57:30.105Z (5 months ago)
- Language: TypeScript
- Size: 973 KB
- Stars: 13
- Watchers: 3
- Forks: 9
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Authors: AUTHORS
Awesome Lists containing this project
README
# nodecg-cli
[NodeCG](https://github.com/nodecg/nodecg)'s command line interface.
[](https://coveralls.io/github/nodecg/nodecg-cli?branch=master)
> ❗ 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](http://git-scm.com/) installed, and that it is in your PATH.
Then, install [bower](http://bower.io/), which may be used to install bundles' dependencies:
```sh
npm install -g bower
```
Once those are installed, you may install nodecg-cli via npm:
```sh
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:
```sh
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 `, 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](https://github.com/tsantef/commander-starter).