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: README.md
+12Lines changed: 12 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,6 +13,7 @@ This is the cli for [nodecg-io](https://github.com/codeoverflow-org/nodecg-io) t
13
13
-[Commands](#commands)
14
14
-[`nodecg-io install`](#nodecg-io-install)
15
15
-[`nodecg-io uninstall`](#nodecg-io-uninstall)
16
+
-[`nodecg-io generate`](#nodecg-io-generate)
16
17
-[A note about versioning](#a-note-about-versioning)
17
18
-[Developer workflow](#developer-workflow)
18
19
@@ -38,6 +39,17 @@ If you later decide that you want to add or remove a service you can just re-run
38
39
39
40
Undos everything that `nodecg-io install` did. It removes the `nodecg-io` directory with your installation and removes nodecg-io from your nodecg configuration.
40
41
42
+
### `nodecg-io generate`
43
+
44
+
Generates a new bundle in the `bundles/` directory in your nodecg installation.
45
+
Allows you to decide on language (typescript or javascript), whether you want a dashboard/graphic and which services you want to use.
46
+
Uses your installed nodecg-io version and services, meaning you need to have the services that you want to use installed.
47
+
48
+
These generated bundles are only meant as a starting point, you may probably do more things like creating a git repository for your bundle,
49
+
add a license, or add other tools like linters.
50
+
51
+
Also this command currently only works with installs of released versions and not with development installs. This is because all bundles using nodecg-io depend on `nodecg-io-core` and if you use typescript each used service as well. For development installs these are not published on npm and you would need some way of linking the packages locally.
52
+
41
53
## A note about versioning
42
54
43
55
This cli follows and is versioned independently from the rest of nodecg-io like `nodecg-io-core` or the services.
0 commit comments