@xemahq/xema 0.15.0 → 0.15.1
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 +18 -0
- package/dist/cli.d.ts.map +1 -1
- package/dist/cli.js +22 -1
- package/dist/cli.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -46,6 +46,24 @@ lifecycle (restart, health, resource limits) to the substrate beneath it
|
|
|
46
46
|
npm i -g @xemahq/xema
|
|
47
47
|
```
|
|
48
48
|
|
|
49
|
+
### Client mode vs developer mode
|
|
50
|
+
|
|
51
|
+
A fresh install starts in **client mode**, for people who USE a Xema deployment:
|
|
52
|
+
`login`, `apply`, `plan`, `run`, `shell`, `objects`, `status`, `logs`.
|
|
53
|
+
|
|
54
|
+
The commands that stand a platform up locally — **`up`, `dev`, `serve`**, which
|
|
55
|
+
the rest of this document is largely about — are the platform contributor's inner
|
|
56
|
+
loop. They are fully functional in client mode but **hidden from `xema --help`**,
|
|
57
|
+
so following the sections below without turning developer mode on gives you
|
|
58
|
+
working commands that `--help` never mentions:
|
|
59
|
+
|
|
60
|
+
```bash
|
|
61
|
+
xema config set dev on # or: export XEMA_DEV=1
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
`xema --help` states this in both modes, and `xema config get` explains which
|
|
65
|
+
input decided it.
|
|
66
|
+
|
|
49
67
|
## Scaffold a config — `xema init`
|
|
50
68
|
|
|
51
69
|
Generate a `xema.config.yaml` tailored to your scenario. Run it with no flags for
|
package/dist/cli.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAgDpC,wBAAgB,YAAY,IAAI,OAAO,
|
|
1
|
+
{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAgDpC,wBAAgB,YAAY,IAAI,OAAO,CAuFtC;AAED,wBAAsB,IAAI,CACxB,IAAI,GAAE,aAAa,CAAC,MAAM,CAAgB,GACzC,OAAO,CAAC,IAAI,CAAC,CAMf"}
|
package/dist/cli.js
CHANGED
|
@@ -71,7 +71,8 @@ function buildProgram() {
|
|
|
71
71
|
(0, objects_1.registerCommand)(program);
|
|
72
72
|
(0, doctor_1.registerCommand)(program);
|
|
73
73
|
(0, config_1.registerCommand)(program);
|
|
74
|
-
|
|
74
|
+
const devMode = (0, dev_mode_1.isDevModeActive)();
|
|
75
|
+
if (!devMode) {
|
|
75
76
|
for (const name of ['dev', 'up', 'serve']) {
|
|
76
77
|
const cmd = program.commands.find((c) => c.name() === name);
|
|
77
78
|
if (cmd) {
|
|
@@ -79,6 +80,26 @@ function buildProgram() {
|
|
|
79
80
|
}
|
|
80
81
|
}
|
|
81
82
|
}
|
|
83
|
+
program.addHelpText('after', devMode
|
|
84
|
+
? [
|
|
85
|
+
'',
|
|
86
|
+
'Developer mode is ON — dev / up / serve are listed above.',
|
|
87
|
+
'Turn it off with `xema config set dev off` (or XEMA_DEV=0).',
|
|
88
|
+
'',
|
|
89
|
+
].join('\n')
|
|
90
|
+
: [
|
|
91
|
+
'',
|
|
92
|
+
'Getting started:',
|
|
93
|
+
' xema login connect this machine to an existing Xema deployment',
|
|
94
|
+
' xema init scaffold a xema.config.yaml for a new one',
|
|
95
|
+
' xema apply apply a xema.yaml manifest to a stack',
|
|
96
|
+
' xema doctor diagnose the local environment',
|
|
97
|
+
'',
|
|
98
|
+
'Running a platform locally (dev / up / serve) is the platform',
|
|
99
|
+
"contributor's loop and is hidden by default. Reveal it with",
|
|
100
|
+
'`xema config set dev on` (or XEMA_DEV=1); the commands work either way.',
|
|
101
|
+
'',
|
|
102
|
+
].join('\n'));
|
|
82
103
|
return program;
|
|
83
104
|
}
|
|
84
105
|
async function main(argv = process.argv) {
|
package/dist/cli.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";;AA6DA,
|
|
1
|
+
{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";;AA6DA,oCAuFC;AAED,oBAQC;AApJD,qCAAuC;AACvC,yCAAiC;AAEjC,yCAAoC;AAEpC,4CAAoE;AACpE,4CAAoE;AACpE,8CAAsE;AACtE,8CAAsE;AACtE,wCAAgE;AAChE,0CAAkE;AAClE,8CAAsE;AACtE,0CAAkE;AAClE,8CAAsE;AACtE,8CAAsE;AACtE,0CAAkE;AAClE,0DAAkF;AAClF,gDAAwE;AACxE,4CAAoE;AACpE,0CAAkE;AAClE,gDAAwE;AACxE,0CAAkE;AAClE,wCAAgE;AAChE,4CAAoE;AACpE,4CAAoE;AACpE,8CAAsE;AACtE,8CAAsE;AACtE,sCAA8D;AAC9D,iDAAmD;AACnD,wDAA4D;AAS5D,SAAS,cAAc;IACrB,MAAM,YAAY,GAAG,IAAA,gBAAI,EAAC,SAAS,EAAE,IAAI,EAAE,cAAc,CAAC,CAAC;IAC3D,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,IAAA,sBAAY,EAAC,YAAY,EAAE,MAAM,CAAC,CAEhE,CAAC;IACF,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxD,MAAM,IAAI,KAAK,CAAC,iCAAiC,YAAY,EAAE,CAAC,CAAC;IACnE,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,MAAM,WAAW,GAAG,cAAc,EAAE,CAAC;AAErC,SAAgB,YAAY;IAC1B,MAAM,OAAO,GAAG,IAAI,mBAAO,EAAE,CAAC;IAC9B,OAAO;SACJ,IAAI,CAAC,MAAM,CAAC;SACZ,WAAW,CAAC,oDAAoD,CAAC;SACjE,OAAO,CAAC,WAAW,EAAE,eAAe,EAAE,uBAAuB,CAAC;SAC9D,kBAAkB,CAAC,IAAI,CAAC;SACxB,aAAa,CAAC,EAAE,eAAe,EAAE,IAAI,EAAE,CAAC,CAAC;IAE5C,IAAA,sBAAY,EAAC,OAAO,CAAC,CAAC;IACtB,IAAA,uBAAa,EAAC,OAAO,CAAC,CAAC;IACvB,IAAA,yBAAe,EAAC,OAAO,CAAC,CAAC;IACzB,IAAA,8BAAoB,EAAC,OAAO,CAAC,CAAC;IAC9B,IAAA,oBAAU,EAAC,OAAO,CAAC,CAAC;IACpB,IAAA,sBAAY,EAAC,OAAO,CAAC,CAAC;IACtB,IAAA,wBAAc,EAAC,OAAO,CAAC,CAAC;IACxB,IAAA,sBAAY,EAAC,OAAO,CAAC,CAAC;IACtB,IAAA,qBAAW,EAAC,OAAO,CAAC,CAAC;IACrB,IAAA,sBAAY,EAAC,OAAO,CAAC,CAAC;IACtB,IAAA,uBAAa,EAAC,OAAO,CAAC,CAAC;IACvB,IAAA,uBAAa,EAAC,OAAO,CAAC,CAAC;IACvB,IAAA,wBAAc,EAAC,OAAO,CAAC,CAAC;IACxB,IAAA,sBAAY,EAAC,OAAO,CAAC,CAAC;IACtB,IAAA,uBAAa,EAAC,OAAO,CAAC,CAAC;IACvB,IAAA,wBAAc,EAAC,OAAO,CAAC,CAAC;IACxB,IAAA,wBAAc,EAAC,OAAO,CAAC,CAAC;IACxB,IAAA,qBAAW,EAAC,OAAO,CAAC,CAAC;IACrB,IAAA,wBAAc,EAAC,OAAO,CAAC,CAAC;IACxB,IAAA,uBAAa,EAAC,OAAO,CAAC,CAAC;IACvB,IAAA,yBAAe,EAAC,OAAO,CAAC,CAAC;IACzB,IAAA,wBAAc,EAAC,OAAO,CAAC,CAAC;IACxB,IAAA,wBAAc,EAAC,OAAO,CAAC,CAAC;IAMxB,MAAM,OAAO,GAAG,IAAA,0BAAe,GAAE,CAAC;IAClC,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,KAAK,MAAM,IAAI,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE,OAAO,CAAC,EAAE,CAAC;YAC1C,MAAM,GAAG,GAAG,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,IAAI,CAAC,CAAC;YAC5D,IAAI,GAAG,EAAE,CAAC;gBAIP,GAAuC,CAAC,OAAO,GAAG,IAAI,CAAC;YAC1D,CAAC;QACH,CAAC;IACH,CAAC;IAcD,OAAO,CAAC,WAAW,CACjB,OAAO,EACP,OAAO;QACL,CAAC,CAAC;YACE,EAAE;YACF,2DAA2D;YAC3D,6DAA6D;YAC7D,EAAE;SACH,CAAC,IAAI,CAAC,IAAI,CAAC;QACd,CAAC,CAAC;YACE,EAAE;YACF,kBAAkB;YAClB,2EAA2E;YAC3E,iEAAiE;YACjE,6DAA6D;YAC7D,sDAAsD;YACtD,EAAE;YACF,+DAA+D;YAC/D,6DAA6D;YAC7D,yEAAyE;YACzE,EAAE;SACH,CAAC,IAAI,CAAC,IAAI,CAAC,CACjB,CAAC;IAEF,OAAO,OAAO,CAAC;AACjB,CAAC;AAEM,KAAK,UAAU,IAAI,CACxB,OAA8B,OAAO,CAAC,IAAI;IAE1C,MAAM,OAAO,GAAG,YAAY,EAAE,CAAC;IAI/B,MAAM,OAAO,CAAC,UAAU,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;AACtC,CAAC;AASD,SAAS,kBAAkB;IACzB,MAAM,IAAI,GAAG,CAAC,GAAY,EAAS,EAAE;QACnC,IACE,OAAO,CAAC,GAAG,CAAC,UAAU,KAAK,GAAG;YAC9B,GAAG,YAAY,KAAK;YACpB,GAAG,CAAC,KAAK,KAAK,SAAS,EACvB,CAAC;YACD,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAC3B,CAAC;aAAM,CAAC;YACN,MAAM,OAAO,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YACjE,OAAO,CAAC,KAAK,CAAC,SAAS,OAAO,EAAE,CAAC,CAAC;QACpC,CAAC;QACD,OAAO,CAAC,IAAI,CAAC,4BAAe,CAAC,YAAY,CAAC,CAAC;IAC7C,CAAC,CAAC;IACF,OAAO,CAAC,EAAE,CAAC,oBAAoB,EAAE,IAAI,CAAC,CAAC;IACvC,OAAO,CAAC,EAAE,CAAC,mBAAmB,EAAE,IAAI,CAAC,CAAC;AACxC,CAAC;AAID,IAAI,OAAO,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;IAC5B,kBAAkB,EAAE,CAAC;IACrB,KAAK,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,GAAY,EAAE,EAAE;QACjC,MAAM,OAAO,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACjE,OAAO,CAAC,KAAK,CAAC,SAAS,OAAO,EAAE,CAAC,CAAC;QAClC,OAAO,CAAC,IAAI,CAAC,4BAAe,CAAC,YAAY,CAAC,CAAC;IAC7C,CAAC,CAAC,CAAC;AACL,CAAC"}
|