Skip to content
This repository was archived by the owner on Apr 13, 2025. It is now read-only.

Commit d4d047c

Browse files
committed
Add notes about uninstalling and installation changes to install guide
1 parent 0f272a0 commit d4d047c

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

docs/getting_started/install.md

+15-2
Original file line numberDiff line numberDiff line change
@@ -69,14 +69,27 @@ nodecg-io install
6969

7070
You will get a prompt which asks you which version you want to install.
7171

72-
- By selecting a version you create a production install that downloads the required packages from npm and setups a npm workspace to install all dependencies. Here you can choose which services you want to install.
72+
- By selecting a actual version (e.g. `0.1`) you create a production install that downloads the required packages from npm and setups a npm workspace to install all dependencies. Here you can choose which services you want to install.
7373

74-
- `development` clones the nodecg-io git repo and builds everything from scratch. We only recommend a dev install if you are sure that you want to contribute to nodecg-io. Here you always must install all services.
74+
- By selecting `development` you create a development install that clones the nodecg-io git repo and builds everything from scratch. We only recommend a dev install if you are sure that you want to contribute to nodecg-io. Here you always must install all services.
7575

7676
For starters we recommend using the latest non-development version.
7777

78+
nodecg-io will always be installed into a `nodecg-io/` directory inside your nodecg installation so that your bundles and all bundles from nodecg-io are separated. The cli will add this path to the loaded bundles in your nodecg configuration automatically, you don't need to worry about it.
79+
80+
If you want to every change your nodecg-io installation to add/remove a service or change the version, you can always re-run `nodecg-io install`. If a nodecg-io installation is found its options will be preselected in the prompt.
81+
7882
## Start nodecg
7983

8084
When starting nodecg you should see that all nodecg-io related bundles should be loaded and that you can you can now access nodecg-io in your nodecg dashboard.
8185

8286
Now you can either install a already existing bundle that uses nodecg-io or [create a new bundle](./create_bundle.md).
87+
88+
## Uninstall nodecg-io
89+
90+
If you want uninstall nodecg-io you can run the following command:
91+
```shell
92+
nodecg-io uninstall
93+
```
94+
95+
This will remove the `nodecg-io` directory inside your nodecg installation and also will remove it from the loaded bundle paths in your nodecg configuration.

0 commit comments

Comments
 (0)