@microtronics/studio-cli 1.1.0-alpha.0 → 1.1.0-alpha.2
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.
- package/README.md +46 -0
- package/dist/main.js +44 -42
- package/dist/studio-cli.d.ts +35 -2
- package/out/api.js +35 -33
- package/out/studio-cli.d.ts +35 -2
- package/package.json +4 -1
- package/studio-cli +1 -1
package/README.md
CHANGED
|
@@ -24,6 +24,52 @@ For a reference on all the available `studio-cli` commands, run `studio-cli --he
|
|
|
24
24
|
[Node.js](https://nodejs.org/en/) version `22` or higher.
|
|
25
25
|
|
|
26
26
|
|
|
27
|
+
## Standalone executables
|
|
28
|
+
|
|
29
|
+
Prebuilt single-file binaries are available for users without a [Node.js](https://nodejs.org) installation. They require no `node_modules` and no global npm install. Each binary is built with [`@yao-pkg/pkg`](https://github.com/yao-pkg/pkg) and bundles the Node 22 runtime, the `usb` native addon and the `pawncc-wasm` DLO compiler. macOS is not built for now.
|
|
30
|
+
|
|
31
|
+
| Platform | Artifact |
|
|
32
|
+
| --- | --- |
|
|
33
|
+
| Windows x64 | `studio-cli-win-x64-<version>.exe` |
|
|
34
|
+
| Linux x64 (glibc) | `studio-cli-linux-x64-<version>` |
|
|
35
|
+
|
|
36
|
+
The Linux binary is glibc-linked and does not run on musl-only distributions such as Alpine.
|
|
37
|
+
|
|
38
|
+
The artifacts are written to `dist/bin/`. Each one is roughly 60-80 MB because it embeds the Node runtime.
|
|
39
|
+
|
|
40
|
+
To build them locally, run from the repo root:
|
|
41
|
+
|
|
42
|
+
```console
|
|
43
|
+
$ npm run build -w cli
|
|
44
|
+
$ npm run build:exe -w cli
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
Or from within `cli/`:
|
|
48
|
+
|
|
49
|
+
```console
|
|
50
|
+
$ npm run build:exe
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
Both targets cross-compile from a single machine. The first run downloads the Node base binaries into pkg's cache.
|
|
54
|
+
The Windows executable also carries the Studio icon and the usual Explorer file properties.
|
|
55
|
+
|
|
56
|
+
The executables check npm once a day for a newer release of the channel they were built from (`alpha`, `rc` or `latest`) and print a notice on exit when one exists. A check that cannot reach the registry is retried after an hour rather than on every run. Because a binary is not an npm install, the notice points at the release issue in Jira instead of `npm i -g`. Set `NO_UPDATE_NOTIFIER` or pass `--no-update-notifier` to turn the check off; it is also skipped in CI and when output is not a terminal. The result is cached in `%LOCALAPPDATA%\studio-cli\update-check.json` (`$XDG_CONFIG_HOME/studio-cli/update-check.json` on Linux).
|
|
57
|
+
|
|
58
|
+
### Unsigned binaries
|
|
59
|
+
|
|
60
|
+
The executables are **not** code-signed - there is no Windows Authenticode signature. This has the following consequences:
|
|
61
|
+
|
|
62
|
+
- **Windows:** SmartScreen may warn on first run. Choose "More info", then "Run anyway".
|
|
63
|
+
- **Linux:** The binary needs the executable bit after download:
|
|
64
|
+
|
|
65
|
+
```console
|
|
66
|
+
$ chmod +x ./studio-cli-linux-x64-<version>
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
The binaries are intended for internal and developer distribution. Code signing is tracked separately.
|
|
70
|
+
|
|
71
|
+
The npm package is unaffected: the binaries are additional artifacts, and `npm i -g @microtronics/studio-cli` remains the supported install path on machines that have Node.
|
|
72
|
+
|
|
27
73
|
## Commands
|
|
28
74
|
|
|
29
75
|
### install (alias: i)
|