@microtronics/studio-cli 0.43.0 → 0.44.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/CHANGELOG.md +13 -11
  2. package/README.md +122 -1
  3. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -1,16 +1,18 @@
1
1
  # Changelog
2
2
 
3
- ## 0.43.0 (2026-01-19)
4
-
5
- ### Features
6
-
7
- * add debug option to enable mdnCom logging ([34dfd29](https://bitbucket.org/microtronics-core/vscode-studio/commits/34dfd29cf2f5e6776e31463a85f0484a6907b13b))
8
- * add support for uploading any amx file to an usb device ([e89f108](https://bitbucket.org/microtronics-core/vscode-studio/commits/e89f1087e22e6c0cc88c8b68bbbcc4f1d813dc4f))
9
- * add USB device detection and listing functionality ([906e3e1](https://bitbucket.org/microtronics-core/vscode-studio/commits/906e3e12bca647f5ceba8b4196f00d507be163d9))
10
- * add USB device listing command ([fb16e1a](https://bitbucket.org/microtronics-core/vscode-studio/commits/fb16e1ab0c9a52e38467b664e4b2b6adb135a249)), closes [#close](https://bitbucket.org/microtronics-core/vscode-studio/issues/close)
11
-
12
- ### Bug Fixes
13
-
3
+ ## 0.44.0 (2026-01-19)
4
+
5
+ ## 0.43.0 (2026-01-19)
6
+
7
+ ### Features
8
+
9
+ * add debug option to enable mdnCom logging ([34dfd29](https://bitbucket.org/microtronics-core/vscode-studio/commits/34dfd29cf2f5e6776e31463a85f0484a6907b13b))
10
+ * add support for uploading any amx file to an usb device ([e89f108](https://bitbucket.org/microtronics-core/vscode-studio/commits/e89f1087e22e6c0cc88c8b68bbbcc4f1d813dc4f))
11
+ * add USB device detection and listing functionality ([906e3e1](https://bitbucket.org/microtronics-core/vscode-studio/commits/906e3e12bca647f5ceba8b4196f00d507be163d9))
12
+ * add USB device listing command ([fb16e1a](https://bitbucket.org/microtronics-core/vscode-studio/commits/fb16e1ab0c9a52e38467b664e4b2b6adb135a249)), closes [#close](https://bitbucket.org/microtronics-core/vscode-studio/issues/close)
13
+
14
+ ### Bug Fixes
15
+
14
16
  * ensure proper exit code on successful USB upload ([cc1ae63](https://bitbucket.org/microtronics-core/vscode-studio/commits/cc1ae632669e785017c2afaa689c3750ba22d7fb))
15
17
 
16
18
  ## 0.42.0 (2026-01-13)
package/README.md CHANGED
@@ -21,9 +21,130 @@ For a reference on all the available `studio-cli` commands, run `studio-cli --he
21
21
 
22
22
  ## Requirements
23
23
 
24
- [Node.js](https://nodejs.org/en/) at least `20.x.x`.
24
+ [Node.js](https://nodejs.org/en/) version `22` or higher.
25
25
 
26
26
 
27
+ ## Commands
28
+
29
+ ### install (alias: i)
30
+ Install all dependencies in your project.
31
+
32
+ ```console
33
+ $ studio-cli install [dependency...]
34
+ ```
35
+
36
+ **Options:**
37
+ - `-e, --env <environment>` - CLI target environment (defaults to STUDIO_ENV environment variable)
38
+ - `--token <API-token>` - API Access Token (defaults to STUDIO_TOKEN environment variable)
39
+
40
+ **Examples:**
41
+ ```console
42
+ $ studio-cli install
43
+ $ studio-cli i
44
+ $ studio-cli install dependency-name
45
+ ```
46
+
47
+ ### build
48
+ Build the project.
49
+
50
+ ```console
51
+ $ studio-cli build [options]
52
+ ```
53
+
54
+ **Options:**
55
+ - `-p, --part <APM part>` - APM part that should be built
56
+ - Available parts: `dde`, `dlo`, `pov`, `blo`, `dfiles`
57
+ - `-e, --env <environment>` - CLI target environment
58
+ - Available environments: `lucky`, `wynni`, `production` (default)
59
+ - `--token <API-token>` - API Access Token
60
+
61
+ **Manifest Overrides:**
62
+ You can overwrite manifest options using the `--option=value` syntax.
63
+
64
+ **Examples:**
65
+ ```console
66
+ $ studio-cli build
67
+ $ studio-cli build --part dlo
68
+ $ studio-cli build --env wynni
69
+ $ studio-cli build --dlo.mainFile="./dlo/test.dlo"
70
+ ```
71
+
72
+ ### publish
73
+ Publish the project to the registry.
74
+
75
+ ```console
76
+ $ studio-cli publish [options]
77
+ ```
78
+
79
+ **Options:**
80
+ - `-ph, --phase <release phase>` - Specify a release phase (default: `release`)
81
+ - Available phases: `alpha`, `beta`, `rc`, `release`, `stage`, `passive`, `withdrawn`
82
+ - `--allowedBackends <null|*|server.xz;server.yz>` - Specify the allowedBackends deployment for this version
83
+ - `null` - No restrictions (default)
84
+ - `*` - All backends allowed
85
+ - `server.xz;server.yz` - Specific backend servers (semicolon-separated)
86
+ - `-e, --env <environment>` - CLI target environment
87
+ - Available environments: `lucky`, `wynni`, `production` (default)
88
+ - `--token <API-token>` - API Access Token
89
+ - `-i, --packagePath <path>` - Publish the provided library or app package. Use "*" for autodetection
90
+
91
+ **Examples:**
92
+ ```console
93
+ $ studio-cli publish
94
+ $ studio-cli publish --phase beta
95
+ $ studio-cli publish --allowedBackends "*"
96
+ $ studio-cli publish --packagePath ./my-package.tar.gz --env wynni
97
+ ```
98
+
99
+ ### package (alias: pack)
100
+ Package the project.
101
+
102
+ ```console
103
+ $ studio-cli package [options]
104
+ ```
105
+
106
+ **Options:**
107
+ - `-ph, --phase <release phase>` - Specify a release phase (default: `release`)
108
+ - Available phases: `alpha`, `beta`, `rc`, `release`, `stage`, `passive`, `withdrawn`
109
+ - `-e, --env <environment>` - CLI target environment
110
+ - Available environments: `lucky`, `wynni`, `production` (default)
111
+ - `--token <API-token>` - API Access Token
112
+
113
+ **Examples:**
114
+ ```console
115
+ $ studio-cli package
116
+ $ studio-cli pack --phase alpha
117
+ $ studio-cli pack --env wynni
118
+ ```
119
+
120
+ ### usb
121
+ USB device management commands.
122
+
123
+ #### usb list
124
+ List available USB devices.
125
+
126
+ ```console
127
+ $ studio-cli usb list
128
+ ```
129
+
130
+ #### usb upload
131
+ Upload an AMX binary to a USB device.
132
+
133
+ ```console
134
+ $ studio-cli usb upload -s <serial> -f <path> [--debug]
135
+ ```
136
+
137
+ **Options:**
138
+ - `-s, --serial <serial>` - Device serial number (16 characters hex) **[required]**
139
+ - `-f, --file <path>` - Path to the AMX file (relative to current directory) **[required]**
140
+ - `--debug` - Enable debug logging
141
+
142
+ **Example:**
143
+ ```console
144
+ $ studio-cli usb upload -s 1234567890ABCDEF -f ./app.amx
145
+ $ studio-cli usb upload -s 1234567890ABCDEF -f ./app.amx --debug
146
+ ```
147
+
27
148
  ## Development
28
149
 
29
150
  Execute commands from the root dir
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@microtronics/studio-cli",
3
- "version": "0.43.0",
3
+ "version": "0.44.0",
4
4
  "description": "Microtronics Studio CLI Tool",
5
5
  "main": "./out/api.js",
6
6
  "typings": "./dist/studio-cli.d.ts",