@todesktop/cli 1.19.0-0 → 1.19.0-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 +38 -2
- package/dist/cli.js +215 -178
- package/dist/cli.js.map +3 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -48,7 +48,7 @@ Create a `todesktop.json` file in the root of your Electron project.
|
|
|
48
48
|
|
|
49
49
|
```json
|
|
50
50
|
{
|
|
51
|
-
"$schema": "https://unpkg.com/@todesktop/cli@1.19.0/schemas/schema.json",
|
|
51
|
+
"$schema": "https://unpkg.com/@todesktop/cli@1.19.0-1/schemas/schema.json",
|
|
52
52
|
"schemaVersion": 1
|
|
53
53
|
"id": "your-todesktop-id",
|
|
54
54
|
"icon": "./desktop-icon.png",
|
|
@@ -242,6 +242,19 @@ We also support:
|
|
|
242
242
|
- `todesktop --help`. Shows the help documentation.
|
|
243
243
|
- `todesktop --version`. Shows the current version of the CLI.
|
|
244
244
|
|
|
245
|
+
### Global Options
|
|
246
|
+
|
|
247
|
+
The following options can be used with any command:
|
|
248
|
+
|
|
249
|
+
- `todesktop --config-dir <path>`. Specify a custom directory for storing CLI
|
|
250
|
+
configuration and credentials. This overrides the default system config
|
|
251
|
+
directory. Can also be set via the `TODESKTOP_CONFIG_DIR` environment
|
|
252
|
+
variable.
|
|
253
|
+
- `todesktop --ephemeral`. Do not persist any configuration or credentials to
|
|
254
|
+
disk. All config is stored in memory only for the duration of the command.
|
|
255
|
+
This is useful for CI environments where credentials are provided via
|
|
256
|
+
environment variables and you don't want anything written to disk.
|
|
257
|
+
|
|
245
258
|
## Introspection & breakpoints
|
|
246
259
|
|
|
247
260
|
Interactive introspection lets you open a shell on a live build agent and pause
|
|
@@ -297,6 +310,27 @@ TODESKTOP_ACCESS_TOKEN=accessToken
|
|
|
297
310
|
TODESKTOP_EMAIL=email
|
|
298
311
|
```
|
|
299
312
|
|
|
313
|
+
### Ephemeral mode for CI
|
|
314
|
+
|
|
315
|
+
In CI environments, you may want to prevent the CLI from writing any credentials
|
|
316
|
+
or configuration to disk. Use the `--ephemeral` flag to store all config in
|
|
317
|
+
memory only:
|
|
318
|
+
|
|
319
|
+
```sh
|
|
320
|
+
todesktop build --ephemeral
|
|
321
|
+
```
|
|
322
|
+
|
|
323
|
+
You can also specify a custom config directory if needed (e.g., for isolated
|
|
324
|
+
build environments):
|
|
325
|
+
|
|
326
|
+
```sh
|
|
327
|
+
todesktop build --config-dir /tmp/todesktop-config
|
|
328
|
+
# Or via environment variable
|
|
329
|
+
TODESKTOP_CONFIG_DIR=/tmp/todesktop-config todesktop build
|
|
330
|
+
```
|
|
331
|
+
|
|
332
|
+
### Async builds with webhooks
|
|
333
|
+
|
|
300
334
|
If you need to run a build in the background, you can use the `--async` flag. To
|
|
301
335
|
get notified when the build is finished you can optionally specify a webhook URL
|
|
302
336
|
which will receive a POST request with the build data:
|
|
@@ -379,7 +413,7 @@ To enable JSON validation and IntelliSense for your `todesktop.json` file in com
|
|
|
379
413
|
- For example, if using a hosted version of the schema:
|
|
380
414
|
```json
|
|
381
415
|
{
|
|
382
|
-
"$schema": "https://unpkg.com/@todesktop/cli@1.19.0/schemas/schema.json",
|
|
416
|
+
"$schema": "https://unpkg.com/@todesktop/cli@1.19.0-1/schemas/schema.json",
|
|
383
417
|
"id": "your-todesktop-id"
|
|
384
418
|
}
|
|
385
419
|
```
|
|
@@ -1598,6 +1632,8 @@ Now, when we build your app on ToDesktop servers, it will also run your custom
|
|
|
1598
1632
|
- dc5fe40: Add `todesktop build --introspect` flag and
|
|
1599
1633
|
`todesktop introspect [buildId]` command for interactive shell access to
|
|
1600
1634
|
in-progress builds
|
|
1635
|
+
- 577d4ad: Add `--config-dir` and `--ephemeral` global flags for custom config
|
|
1636
|
+
storage
|
|
1601
1637
|
|
|
1602
1638
|
### 1.18.3
|
|
1603
1639
|
|