@azx-pbc/helix-cli 0.3.0 → 0.4.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.
- package/README.md +14 -8
- package/dist/helix.js +1249 -579
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -21,17 +21,23 @@ is wherever you're standing.
|
|
|
21
21
|
Each setting is resolved **flags → environment → `helix.json` → built-in default**
|
|
22
22
|
(first match wins):
|
|
23
23
|
|
|
24
|
-
| Setting
|
|
25
|
-
|
|
|
26
|
-
| App slug
|
|
27
|
-
| Portal URL
|
|
28
|
-
| Build dir
|
|
29
|
-
| Auth token
|
|
24
|
+
| Setting | Flag | Env | `helix.json` key | Default |
|
|
25
|
+
| ----------- | --------------- | ------------------ | ---------------- | -------------------------- |
|
|
26
|
+
| App slug | `--slug` | — | `slug` | _(required)_ |
|
|
27
|
+
| Portal URL | `--portal-url` | `HELIX_PORTAL_URL` | `portalUrl` | `http://localhost:3001` |
|
|
28
|
+
| Build dir | `--dir` | — | `dir` | `dist` |
|
|
29
|
+
| Auth token | `--token` | `HELIX_TOKEN` | — | _(`helix login` if unset)_ |
|
|
30
|
+
| Description | `--description` | — | `description` | — |
|
|
30
31
|
|
|
31
32
|
A `helix.json` looks like:
|
|
32
33
|
|
|
33
34
|
```json
|
|
34
|
-
{
|
|
35
|
+
{
|
|
36
|
+
"slug": "my-app",
|
|
37
|
+
"dir": "dist",
|
|
38
|
+
"portalUrl": "https://portal.example.com",
|
|
39
|
+
"description": "Tracks Q3 cloud spend by team."
|
|
40
|
+
}
|
|
35
41
|
```
|
|
36
42
|
|
|
37
43
|
**`portalUrl` is the one you cannot leave to the default.** `http://localhost:3001`
|
|
@@ -55,7 +61,7 @@ would be wrong for every deployment but one — so to deploy an example, add
|
|
|
55
61
|
helix login # browser sign-in (OIDC device flow)
|
|
56
62
|
helix logout # forget the cached tokens
|
|
57
63
|
helix whoami # who the portal thinks you are
|
|
58
|
-
helix create [--display-name <name>] [--visibility <v>] # register the app
|
|
64
|
+
helix create [--display-name <name>] [--description <text>] [--visibility <v>] # register the app
|
|
59
65
|
helix deploy [--dir <dir>] [--bundle <zip>] [--promote] # upload a version
|
|
60
66
|
helix versions # list versions
|
|
61
67
|
helix promote <number> # make a version live
|