You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Apr 13, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: docs/getting_started/install.md
+16-2
Original file line number
Diff line number
Diff line change
@@ -69,14 +69,28 @@ nodecg-io install
69
69
70
70
You will get a prompt which asks you which version you want to install.
71
71
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.
73
73
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.
75
75
76
76
For starters we recommend using the latest non-development version.
77
77
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
+
78
82
## Start nodecg
79
83
80
84
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.
81
85
82
86
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
+
92
+
```shell
93
+
nodecg-io uninstall
94
+
```
95
+
96
+
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