Skip to content

Commit

Permalink
docs: update README (#126)
Browse files Browse the repository at this point in the history
  • Loading branch information
Hoishin authored Dec 27, 2024
1 parent c5efb0b commit 817e25d
Showing 1 changed file with 29 additions and 24 deletions.
53 changes: 29 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,44 +2,49 @@

[NodeCG](https://github.com/nodecg/nodecg)'s command line interface.

![CI](https://github.com/nodecg/nodecg-cli/workflows/CI/badge.svg?branch=master)
[![Coverage Status](https://coveralls.io/repos/github/nodecg/nodecg-cli/badge.svg?branch=master)](https://coveralls.io/github/nodecg/nodecg-cli?branch=master)
[![CI](https://github.com/nodecg/nodecg-cli/actions/workflows/ci.yml/badge.svg)](https://github.com/nodecg/nodecg-cli/actions/workflows/ci.yml)

> ❗ 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`.
## Compatibility

- `nodecg-cli` version earlier than 8.6.1 is not compatible with NodeCG 2.x.x.
- `nodecg-cli` version 9.0.0 and later are not compatible with NodeCG 0.x.x and 1.x.x.

| NodeCG | nodecg-cli |
| ------ | ---------- |
| 0.x.x | < 9.0.0 |
| 1.x.x | < 9.0.0 |
| 2.x.x | >= 8.6.1 |

## 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`.
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 <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](https://github.com/tsantef/commander-starter).

- `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)

0 comments on commit 817e25d

Please sign in to comment.