balena-cli 23.1.1 → 23.1.2-build-remove-help-patch-149117ec0c36346e2eadac5823d0cacbb5a40349-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/CHANGELOG.md +4 -0
- package/build/help.d.ts +5 -1
- package/build/help.js +24 -0
- package/build/help.js.map +1 -1
- package/npm-shrinkwrap.json +2 -2
- package/oclif.manifest.json +234 -234
- package/package.json +2 -2
- package/patches/all/@oclif+core+4.5.6.patch +0 -19
- package/src/help.ts +31 -1
package/CHANGELOG.md
CHANGED
|
@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file
|
|
|
4
4
|
automatically by Versionist. DO NOT EDIT THIS FILE MANUALLY!
|
|
5
5
|
This project adheres to [Semantic Versioning](http://semver.org/).
|
|
6
6
|
|
|
7
|
+
## 23.1.2 - 2025-11-18
|
|
8
|
+
|
|
9
|
+
* help: Replace the oclif patch for hiding subtopics with overrides in the BalenaHelp class [Thodoris Greasidis]
|
|
10
|
+
|
|
7
11
|
## 23.1.1 - 2025-11-18
|
|
8
12
|
|
|
9
13
|
* Drop some usage of lodash in favor of native equivalents [Matthew Yarmolinsky]
|
package/build/help.d.ts
CHANGED
|
@@ -1,7 +1,11 @@
|
|
|
1
|
-
import type { Command } from '@oclif/core';
|
|
1
|
+
import type { Command, Interfaces } from '@oclif/core';
|
|
2
2
|
import { Help } from '@oclif/core';
|
|
3
3
|
import type { ResolvableReturnType } from 'balena-sdk/typings/utils';
|
|
4
4
|
export default class BalenaHelp extends Help {
|
|
5
|
+
private SUPPRESS_SUBTOPICS_DEPTH;
|
|
6
|
+
protected get sortedCommands(): Command.Loadable[];
|
|
7
|
+
protected get sortedTopics(): Interfaces.Topic[];
|
|
8
|
+
showCommandHelp(command: Command.Loadable): Promise<void>;
|
|
5
9
|
showHelp(argv: string[]): Promise<void>;
|
|
6
10
|
getCustomRootHelp(showAllCommands: boolean): string;
|
|
7
11
|
protected formatGlobalOpts(opts: string[][]): string;
|
package/build/help.js
CHANGED
|
@@ -20,6 +20,7 @@ function getHelpSubject(args) {
|
|
|
20
20
|
class BalenaHelp extends core_1.Help {
|
|
21
21
|
constructor() {
|
|
22
22
|
super(...arguments);
|
|
23
|
+
this.SUPPRESS_SUBTOPICS_DEPTH = null;
|
|
23
24
|
this.manuallySortedPrimaryCommands = [
|
|
24
25
|
'login',
|
|
25
26
|
'push',
|
|
@@ -32,6 +33,29 @@ class BalenaHelp extends core_1.Help {
|
|
|
32
33
|
'leave',
|
|
33
34
|
];
|
|
34
35
|
}
|
|
36
|
+
get sortedCommands() {
|
|
37
|
+
const commands = super.sortedCommands;
|
|
38
|
+
if (this.SUPPRESS_SUBTOPICS_DEPTH == null) {
|
|
39
|
+
return commands;
|
|
40
|
+
}
|
|
41
|
+
const depth = this.SUPPRESS_SUBTOPICS_DEPTH;
|
|
42
|
+
return commands.filter((c) => c.id.split(':').length <= depth);
|
|
43
|
+
}
|
|
44
|
+
get sortedTopics() {
|
|
45
|
+
const topics = super.sortedTopics;
|
|
46
|
+
if (this.SUPPRESS_SUBTOPICS_DEPTH == null) {
|
|
47
|
+
return topics;
|
|
48
|
+
}
|
|
49
|
+
const depth = this.SUPPRESS_SUBTOPICS_DEPTH;
|
|
50
|
+
return topics.filter((t) => t.name.split(':').length <= depth);
|
|
51
|
+
}
|
|
52
|
+
async showCommandHelp(command) {
|
|
53
|
+
const name = command.id;
|
|
54
|
+
const depth = name.split(':').length;
|
|
55
|
+
this.SUPPRESS_SUBTOPICS_DEPTH = depth;
|
|
56
|
+
await super.showCommandHelp(command);
|
|
57
|
+
this.SUPPRESS_SUBTOPICS_DEPTH = null;
|
|
58
|
+
}
|
|
35
59
|
async showHelp(argv) {
|
|
36
60
|
const ux = (0, lazy_1.getCliUx)();
|
|
37
61
|
const subject = getHelpSubject(argv);
|
package/build/help.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"help.js","sourceRoot":"","sources":["../src/help.ts"],"names":[],"mappings":";;AAiBA,sCAAmC;AACnC,wCAAwC;AAExC,uCAAwC;AAKxC,SAAS,cAAc,CAAC,IAAc;IACrC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACxB,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;YAClB,OAAO;QACR,CAAC;QACD,IAAI,GAAG,KAAK,MAAM,IAAI,GAAG,KAAK,QAAQ,EAAE,CAAC;YACxC,SAAS;QACV,CAAC;QACD,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YACzB,OAAO;QACR,CAAC;QACD,OAAO,GAAG,CAAC;IACZ,CAAC;AACF,CAAC;AAED,MAAqB,UAAW,SAAQ,WAAI;IAA5C;;
|
|
1
|
+
{"version":3,"file":"help.js","sourceRoot":"","sources":["../src/help.ts"],"names":[],"mappings":";;AAiBA,sCAAmC;AACnC,wCAAwC;AAExC,uCAAwC;AAKxC,SAAS,cAAc,CAAC,IAAc;IACrC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACxB,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;YAClB,OAAO;QACR,CAAC;QACD,IAAI,GAAG,KAAK,MAAM,IAAI,GAAG,KAAK,QAAQ,EAAE,CAAC;YACxC,SAAS;QACV,CAAC;QACD,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YACzB,OAAO;QACR,CAAC;QACD,OAAO,GAAG,CAAC;IACZ,CAAC;AACF,CAAC;AAED,MAAqB,UAAW,SAAQ,WAAI;IAA5C;;QACS,6BAAwB,GAAkB,IAAI,CAAC;QA0N9C,kCAA6B,GAAG;YACxC,OAAO;YACP,MAAM;YACN,OAAO;YACP,QAAQ;YACR,SAAS;YACT,OAAO;YACP,QAAQ;YACR,MAAM;YACN,OAAO;SACP,CAAC;IACH,CAAC;IAnOA,IAAc,cAAc;QAC3B,MAAM,QAAQ,GAAG,KAAK,CAAC,cAAc,CAAC;QACtC,IAAI,IAAI,CAAC,wBAAwB,IAAI,IAAI,EAAE,CAAC;YAC3C,OAAO,QAAQ,CAAC;QACjB,CAAC;QAED,MAAM,KAAK,GAAG,IAAI,CAAC,wBAAwB,CAAC;QAC5C,OAAO,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,IAAI,KAAK,CAAC,CAAC;IAChE,CAAC;IAED,IAAc,YAAY;QACzB,MAAM,MAAM,GAAG,KAAK,CAAC,YAAY,CAAC;QAClC,IAAI,IAAI,CAAC,wBAAwB,IAAI,IAAI,EAAE,CAAC;YAC3C,OAAO,MAAM,CAAC;QACf,CAAC;QAED,MAAM,KAAK,GAAG,IAAI,CAAC,wBAAwB,CAAC;QAC5C,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,IAAI,KAAK,CAAC,CAAC;IAChE,CAAC;IAEM,KAAK,CAAC,eAAe,CAAC,OAAyB;QACrD,MAAM,IAAI,GAAG,OAAO,CAAC,EAAE,CAAC;QACxB,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC;QACrC,IAAI,CAAC,wBAAwB,GAAG,KAAK,CAAC;QACtC,MAAM,KAAK,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;QACrC,IAAI,CAAC,wBAAwB,GAAG,IAAI,CAAC;IACtC,CAAC;IAEM,KAAK,CAAC,QAAQ,CAAC,IAAc;QACnC,MAAM,EAAE,GAAG,IAAA,eAAQ,GAAE,CAAC;QACtB,MAAM,OAAO,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC;QACrC,IAAI,CAAC,OAAO,EAAE,CAAC;YACd,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;YAClE,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC;YAC7C,OAAO;QACR,CAAC;QAED,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QACjD,IAAI,OAAO,EAAE,CAAC;YACb,MAAM,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;YACpC,OAAO;QACR,CAAC;QAID,MAAM,aAAa,GAAG,MAAM,OAAO,CAAC,GAAG,CACtC,IAAI,CAAC,MAAM,CAAC,QAAQ;aAClB,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE;YACb,OAAO,CAAC,CAAC,EAAE,CAAC,UAAU,CAAC,GAAG,OAAO,GAAG,CAAC,CAAC;QACvC,CAAC,CAAC;aACD,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAC9B,CAAC;QAEF,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC9B,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,oBAAoB,CAAC,CAAC;YACnE,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC,CAAC;YAChD,OAAO,CAAC,GAAG,CACV,SAAS,EAAE,CAAC,QAAQ,CAAC,MAAM,EAAE,EAAE,CAAC,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC,wCAAwC,CAC3G,CAAC;YACF,OAAO,CAAC,GAAG,CACV,OAAO,EAAE,CAAC,QAAQ,CAAC,MAAM,EAAE,EAAE,CAAC,QAAQ,CAAC,MAAM,EAAE,uBAAuB,CAAC,CAAC,2CAA2C,CACnH,CAAC;YACF,OAAO;QACR,CAAC;QAED,OAAO,CAAC,GAAG,CACV,WAAW,EAAE,CAAC,QAAQ,CAAC,MAAM,EAAE,EAAE,CAAC,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,YAAY,CACxE,CAAC;IACH,CAAC;IAED,iBAAiB,CAAC,eAAwB;QACzC,MAAM,EAAE,GAAG,IAAA,eAAQ,GAAE,CAAC;QACtB,IAAI,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC;QAEpC,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;QAG9D,MAAM,eAAe,GAAG,IAAI,CAAC,6BAA6B;aACxD,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE;YACX,OAAO,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;QAC5D,CAAC,CAAC;aACD,MAAM,CAAC,CAAC,CAAC,EAA6B,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAEhD,IAAI,SAAS,GAAG,CAAC,CAAC;QAClB,KAAK,MAAM,GAAG,IAAI,eAAe,EAAE,CAAC;YACnC,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,GAAG,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC;QAChD,CAAC;QAED,IAAI,oBAA8B,CAAC;QACnC,IAAI,eAAe,EAAE,CAAC;YAErB,MAAM,kBAAkB,GAAG,QAAQ,CAAC,MAAM,CACzC,CAAC,CAAC,EAAE,EAAE,CACL,CAAC,IAAI,CAAC,6BAA6B,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CACrE,CAAC;YAIF,KAAK,MAAM,GAAG,IAAI,kBAAkB,EAAE,CAAC;gBACtC,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,GAAG,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC;YAChD,CAAC;YAED,IACC,OAAO,eAAe,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,QAAQ;gBACzC,OAAO,kBAAkB,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,QAAQ,EAC3C,CAAC;gBACF,eAAe,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,eAAe,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;gBAChE,kBAAkB,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,kBAAkB,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;YACvE,CAAC;YAED,oBAAoB,GAAG;gBACtB,EAAE,CAAC,QAAQ,CAAC,MAAM,EAAE,uBAAuB,CAAC;gBAC5C,IAAI,CAAC,cAAc,CAAC,kBAAkB,CAAC;aACvC,CAAC;QACH,CAAC;aAAM,CAAC;YACP,MAAM,GAAG,GAAG,EAAE,CAAC,QAAQ,CACtB,MAAM,EACN,EAAE,CAAC,QAAQ,CAAC,MAAM,EAAE,uBAAuB,CAAC,CAC5C,CAAC;YACF,oBAAoB,GAAG;gBACtB,KAAK,EAAE,CAAC,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAC,QAAQ,GAAG,+BAA+B;aAC7E,CAAC;QACH,CAAC;QAED,MAAM,SAAS,GAAG;YACjB,CAAC,QAAQ,EAAE,sBAAsB,CAAC;YAClC,CAAC,SAAS,EAAE,qBAAqB,CAAC;YAClC;gBACC,eAAe;gBACf;;6CAEyC;aACzC;SACD,CAAC;QACF,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAEpD,MAAM,EAAE,qBAAqB,EAAE,WAAW,EAAE,GAC3C,OAAO,CAAC,kBAAkB,CAAsC,CAAC;QAElE,OAAO;YACN,EAAE,CAAC,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;YAC5B,8BAA8B;YAC9B,EAAE,CAAC,QAAQ,CAAC,MAAM,EAAE,oBAAoB,CAAC;YACzC,IAAI,CAAC,cAAc,CAAC,eAAe,CAAC;YACpC,GAAG,oBAAoB;YACvB,EAAE,CAAC,QAAQ,CAAC,MAAM,EAAE,kBAAkB,CAAC;YACvC,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC;YAChC,EAAE,CAAC,QAAQ,CAAC,MAAM,EAAE,+BAA+B,CAAC;YACpD,qBAAqB;YACrB,WAAW;SACX,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACd,CAAC;IAES,gBAAgB,CAAC,IAAgB;QAC1C,MAAM,EAAE,GAAG,IAAA,eAAQ,GAAE,CAAC;QACtB,MAAM,QAAQ,GAAa,EAAE,CAAC;QAC9B,IAAI,SAAS,GAAG,CAAC,CAAC;QAClB,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACxB,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;QAChD,CAAC;QACD,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACxB,MAAM,gBAAgB,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAC5C,QAAQ,CAAC,IAAI,CACZ,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,KAAK,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAAC,EAAE,CAC7E,CAAC;YACF,QAAQ,CAAC,IAAI,CACZ,GAAG,gBAAgB;iBACjB,KAAK,CAAC,CAAC,CAAC;iBACR,GAAG,CACH,CAAC,IAAI,EAAE,EAAE,CACR,KAAK,GAAG,CAAC,MAAM,CAAC,SAAS,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,CAC5D,CACF,CAAC;QACH,CAAC;QACD,OAAO,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAES,cAAc,CACvB,QAEC;QAED,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC3B,OAAO,EAAE,CAAC;QACX,CAAC;QAED,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAC3B,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;YACnB,CAAC,CAAC,EAAE,CAAC,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC;YACzB,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC,WAAW,CAAC;SACrC,CAAC,EACF;YACC,MAAM,EAAE,IAAI;YACZ,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,SAAS;YAC9B,WAAW,EAAE,CAAC;YACd,SAAS,EAAE,KAAK;SAChB,CACD,CAAC;QAEF,OAAO,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IACxB,CAAC;IAES,iBAAiB,CAAC,IAAI,GAAG,EAAE;QACpC,MAAM,EAAE,GAAG,IAAA,eAAQ,GAAE,CAAC;QACtB,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QAE3B,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YACxB,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAC3C,CAAC;QAED,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC;YAC1D,IAAI,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC;QACvD,CAAC;QACD,OAAO,EAAE,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAClC,CAAC;CAaD;AAtOD,6BAsOC"}
|
package/npm-shrinkwrap.json
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "balena-cli",
|
|
3
|
-
"version": "23.1.1",
|
|
3
|
+
"version": "23.1.2-build-remove-help-patch-149117ec0c36346e2eadac5823d0cacbb5a40349-1",
|
|
4
4
|
"lockfileVersion": 3,
|
|
5
5
|
"requires": true,
|
|
6
6
|
"packages": {
|
|
7
7
|
"": {
|
|
8
8
|
"name": "balena-cli",
|
|
9
|
-
"version": "23.1.1",
|
|
9
|
+
"version": "23.1.2-build-remove-help-patch-149117ec0c36346e2eadac5823d0cacbb5a40349-1",
|
|
10
10
|
"hasInstallScript": true,
|
|
11
11
|
"license": "Apache-2.0",
|
|
12
12
|
"dependencies": {
|
package/oclif.manifest.json
CHANGED
|
@@ -160,6 +160,56 @@
|
|
|
160
160
|
"create.js"
|
|
161
161
|
]
|
|
162
162
|
},
|
|
163
|
+
"block:create": {
|
|
164
|
+
"aliases": [],
|
|
165
|
+
"args": {
|
|
166
|
+
"name": {
|
|
167
|
+
"description": "block name",
|
|
168
|
+
"name": "name",
|
|
169
|
+
"required": true
|
|
170
|
+
}
|
|
171
|
+
},
|
|
172
|
+
"description": "Create an block.\n\nCreate a new balena block.\n\nYou can specify the organization the block should belong to using\nthe `--organization` option. The organization's handle, not its name,\nshould be provided. Organization handles can be listed with the\n`balena organization list` command.\n\nThe block's default device type is specified with the `--type` option.\nThe `balena device-type list` command can be used to list the available\ndevice types.\n\nInteractive dropdowns will be shown for selection if no device type or\norganization is specified and there are multiple options to choose from.\nIf there is a single option to choose from, it will be chosen automatically.\nThis interactive behavior can be disabled by explicitly specifying a device\ntype and organization.",
|
|
173
|
+
"examples": [
|
|
174
|
+
"$ balena block create MyBlock",
|
|
175
|
+
"$ balena block create MyBlock --organization mmyorg",
|
|
176
|
+
"$ balena block create MyBlock -o myorg --type raspberry-pi"
|
|
177
|
+
],
|
|
178
|
+
"flags": {
|
|
179
|
+
"organization": {
|
|
180
|
+
"char": "o",
|
|
181
|
+
"description": "handle of the organization the block should belong to",
|
|
182
|
+
"name": "organization",
|
|
183
|
+
"hasDynamicHelp": false,
|
|
184
|
+
"multiple": false,
|
|
185
|
+
"type": "option"
|
|
186
|
+
},
|
|
187
|
+
"type": {
|
|
188
|
+
"char": "t",
|
|
189
|
+
"description": "block device type (Check available types with `balena device-type list`)",
|
|
190
|
+
"name": "type",
|
|
191
|
+
"hasDynamicHelp": false,
|
|
192
|
+
"multiple": false,
|
|
193
|
+
"type": "option"
|
|
194
|
+
}
|
|
195
|
+
},
|
|
196
|
+
"hasDynamicHelp": false,
|
|
197
|
+
"hiddenAliases": [],
|
|
198
|
+
"id": "block:create",
|
|
199
|
+
"pluginAlias": "balena-cli",
|
|
200
|
+
"pluginName": "balena-cli",
|
|
201
|
+
"pluginType": "core",
|
|
202
|
+
"strict": true,
|
|
203
|
+
"enableJsonFlag": false,
|
|
204
|
+
"authenticated": true,
|
|
205
|
+
"isESM": false,
|
|
206
|
+
"relativePath": [
|
|
207
|
+
"build",
|
|
208
|
+
"commands",
|
|
209
|
+
"block",
|
|
210
|
+
"create.js"
|
|
211
|
+
]
|
|
212
|
+
},
|
|
163
213
|
"build": {
|
|
164
214
|
"aliases": [],
|
|
165
215
|
"args": {
|
|
@@ -706,56 +756,6 @@
|
|
|
706
756
|
"write.js"
|
|
707
757
|
]
|
|
708
758
|
},
|
|
709
|
-
"block:create": {
|
|
710
|
-
"aliases": [],
|
|
711
|
-
"args": {
|
|
712
|
-
"name": {
|
|
713
|
-
"description": "block name",
|
|
714
|
-
"name": "name",
|
|
715
|
-
"required": true
|
|
716
|
-
}
|
|
717
|
-
},
|
|
718
|
-
"description": "Create an block.\n\nCreate a new balena block.\n\nYou can specify the organization the block should belong to using\nthe `--organization` option. The organization's handle, not its name,\nshould be provided. Organization handles can be listed with the\n`balena organization list` command.\n\nThe block's default device type is specified with the `--type` option.\nThe `balena device-type list` command can be used to list the available\ndevice types.\n\nInteractive dropdowns will be shown for selection if no device type or\norganization is specified and there are multiple options to choose from.\nIf there is a single option to choose from, it will be chosen automatically.\nThis interactive behavior can be disabled by explicitly specifying a device\ntype and organization.",
|
|
719
|
-
"examples": [
|
|
720
|
-
"$ balena block create MyBlock",
|
|
721
|
-
"$ balena block create MyBlock --organization mmyorg",
|
|
722
|
-
"$ balena block create MyBlock -o myorg --type raspberry-pi"
|
|
723
|
-
],
|
|
724
|
-
"flags": {
|
|
725
|
-
"organization": {
|
|
726
|
-
"char": "o",
|
|
727
|
-
"description": "handle of the organization the block should belong to",
|
|
728
|
-
"name": "organization",
|
|
729
|
-
"hasDynamicHelp": false,
|
|
730
|
-
"multiple": false,
|
|
731
|
-
"type": "option"
|
|
732
|
-
},
|
|
733
|
-
"type": {
|
|
734
|
-
"char": "t",
|
|
735
|
-
"description": "block device type (Check available types with `balena device-type list`)",
|
|
736
|
-
"name": "type",
|
|
737
|
-
"hasDynamicHelp": false,
|
|
738
|
-
"multiple": false,
|
|
739
|
-
"type": "option"
|
|
740
|
-
}
|
|
741
|
-
},
|
|
742
|
-
"hasDynamicHelp": false,
|
|
743
|
-
"hiddenAliases": [],
|
|
744
|
-
"id": "block:create",
|
|
745
|
-
"pluginAlias": "balena-cli",
|
|
746
|
-
"pluginName": "balena-cli",
|
|
747
|
-
"pluginType": "core",
|
|
748
|
-
"strict": true,
|
|
749
|
-
"enableJsonFlag": false,
|
|
750
|
-
"authenticated": true,
|
|
751
|
-
"isESM": false,
|
|
752
|
-
"relativePath": [
|
|
753
|
-
"build",
|
|
754
|
-
"commands",
|
|
755
|
-
"block",
|
|
756
|
-
"create.js"
|
|
757
|
-
]
|
|
758
|
-
},
|
|
759
759
|
"deploy": {
|
|
760
760
|
"aliases": [],
|
|
761
761
|
"args": {
|
|
@@ -2916,59 +2916,6 @@
|
|
|
2916
2916
|
"osinit.js"
|
|
2917
2917
|
]
|
|
2918
2918
|
},
|
|
2919
|
-
"join": {
|
|
2920
|
-
"aliases": [],
|
|
2921
|
-
"args": {
|
|
2922
|
-
"deviceIpOrHostname": {
|
|
2923
|
-
"description": "the IP or hostname of device",
|
|
2924
|
-
"name": "deviceIpOrHostname"
|
|
2925
|
-
}
|
|
2926
|
-
},
|
|
2927
|
-
"description": "Move a local device to a fleet on another balena server.\n\nMove a local device to a fleet on another balena server, causing\nthe device to \"join\" the new server. The device must be running balenaOS.\n\nFor example, you could provision a device against an openBalena installation\nwhere you perform end-to-end tests and then move it to balenaCloud when it's\nready for production.\n\nTo move a device between fleets on the same server, use the\n`balena device move` command instead of `balena join`.\n\nIf you don't specify a device hostname or IP, this command will automatically\nscan the local network for balenaOS devices and prompt you to select one\nfrom an interactive picker. This may require administrator/root privileges.\nLikewise, if the fleet option is not provided then a picker will be shown.\n\nFleets may be specified by fleet name or slug. Fleet slugs are\nthe recommended option, as they are unique and unambiguous. Slugs can be\nlisted with the `balena fleet list` command. Note that slugs may change if the\nfleet is renamed. Fleet names are not unique and may result in \"Fleet is\nambiguous\" errors at any time (even if it \"used to work in the past\"), for\nexample if the name clashes with a newly created public fleet, or with fleets\nfrom other balena accounts that you may be invited to join under any role.\nFor this reason, fleet names are especially discouraged in scripts (e.g. CI\nenvironments).",
|
|
2928
|
-
"examples": [
|
|
2929
|
-
"$ balena join",
|
|
2930
|
-
"$ balena join balena.local",
|
|
2931
|
-
"$ balena join balena.local --fleet MyFleet",
|
|
2932
|
-
"$ balena join balena.local -f myorg/myfleet",
|
|
2933
|
-
"$ balena join 192.168.1.25",
|
|
2934
|
-
"$ balena join 192.168.1.25 --fleet MyFleet"
|
|
2935
|
-
],
|
|
2936
|
-
"flags": {
|
|
2937
|
-
"fleet": {
|
|
2938
|
-
"char": "f",
|
|
2939
|
-
"description": "fleet name or slug (preferred)",
|
|
2940
|
-
"name": "fleet",
|
|
2941
|
-
"hasDynamicHelp": false,
|
|
2942
|
-
"multiple": false,
|
|
2943
|
-
"type": "option"
|
|
2944
|
-
},
|
|
2945
|
-
"pollInterval": {
|
|
2946
|
-
"char": "i",
|
|
2947
|
-
"description": "the interval in minutes to check for updates",
|
|
2948
|
-
"name": "pollInterval",
|
|
2949
|
-
"hasDynamicHelp": false,
|
|
2950
|
-
"multiple": false,
|
|
2951
|
-
"type": "option"
|
|
2952
|
-
}
|
|
2953
|
-
},
|
|
2954
|
-
"hasDynamicHelp": false,
|
|
2955
|
-
"hiddenAliases": [],
|
|
2956
|
-
"id": "join",
|
|
2957
|
-
"pluginAlias": "balena-cli",
|
|
2958
|
-
"pluginName": "balena-cli",
|
|
2959
|
-
"pluginType": "core",
|
|
2960
|
-
"strict": true,
|
|
2961
|
-
"enableJsonFlag": false,
|
|
2962
|
-
"authenticated": true,
|
|
2963
|
-
"primary": true,
|
|
2964
|
-
"isESM": false,
|
|
2965
|
-
"relativePath": [
|
|
2966
|
-
"build",
|
|
2967
|
-
"commands",
|
|
2968
|
-
"join",
|
|
2969
|
-
"index.js"
|
|
2970
|
-
]
|
|
2971
|
-
},
|
|
2972
2919
|
"leave": {
|
|
2973
2920
|
"aliases": [],
|
|
2974
2921
|
"args": {
|
|
@@ -3209,6 +3156,59 @@
|
|
|
3209
3156
|
"index.js"
|
|
3210
3157
|
]
|
|
3211
3158
|
},
|
|
3159
|
+
"join": {
|
|
3160
|
+
"aliases": [],
|
|
3161
|
+
"args": {
|
|
3162
|
+
"deviceIpOrHostname": {
|
|
3163
|
+
"description": "the IP or hostname of device",
|
|
3164
|
+
"name": "deviceIpOrHostname"
|
|
3165
|
+
}
|
|
3166
|
+
},
|
|
3167
|
+
"description": "Move a local device to a fleet on another balena server.\n\nMove a local device to a fleet on another balena server, causing\nthe device to \"join\" the new server. The device must be running balenaOS.\n\nFor example, you could provision a device against an openBalena installation\nwhere you perform end-to-end tests and then move it to balenaCloud when it's\nready for production.\n\nTo move a device between fleets on the same server, use the\n`balena device move` command instead of `balena join`.\n\nIf you don't specify a device hostname or IP, this command will automatically\nscan the local network for balenaOS devices and prompt you to select one\nfrom an interactive picker. This may require administrator/root privileges.\nLikewise, if the fleet option is not provided then a picker will be shown.\n\nFleets may be specified by fleet name or slug. Fleet slugs are\nthe recommended option, as they are unique and unambiguous. Slugs can be\nlisted with the `balena fleet list` command. Note that slugs may change if the\nfleet is renamed. Fleet names are not unique and may result in \"Fleet is\nambiguous\" errors at any time (even if it \"used to work in the past\"), for\nexample if the name clashes with a newly created public fleet, or with fleets\nfrom other balena accounts that you may be invited to join under any role.\nFor this reason, fleet names are especially discouraged in scripts (e.g. CI\nenvironments).",
|
|
3168
|
+
"examples": [
|
|
3169
|
+
"$ balena join",
|
|
3170
|
+
"$ balena join balena.local",
|
|
3171
|
+
"$ balena join balena.local --fleet MyFleet",
|
|
3172
|
+
"$ balena join balena.local -f myorg/myfleet",
|
|
3173
|
+
"$ balena join 192.168.1.25",
|
|
3174
|
+
"$ balena join 192.168.1.25 --fleet MyFleet"
|
|
3175
|
+
],
|
|
3176
|
+
"flags": {
|
|
3177
|
+
"fleet": {
|
|
3178
|
+
"char": "f",
|
|
3179
|
+
"description": "fleet name or slug (preferred)",
|
|
3180
|
+
"name": "fleet",
|
|
3181
|
+
"hasDynamicHelp": false,
|
|
3182
|
+
"multiple": false,
|
|
3183
|
+
"type": "option"
|
|
3184
|
+
},
|
|
3185
|
+
"pollInterval": {
|
|
3186
|
+
"char": "i",
|
|
3187
|
+
"description": "the interval in minutes to check for updates",
|
|
3188
|
+
"name": "pollInterval",
|
|
3189
|
+
"hasDynamicHelp": false,
|
|
3190
|
+
"multiple": false,
|
|
3191
|
+
"type": "option"
|
|
3192
|
+
}
|
|
3193
|
+
},
|
|
3194
|
+
"hasDynamicHelp": false,
|
|
3195
|
+
"hiddenAliases": [],
|
|
3196
|
+
"id": "join",
|
|
3197
|
+
"pluginAlias": "balena-cli",
|
|
3198
|
+
"pluginName": "balena-cli",
|
|
3199
|
+
"pluginType": "core",
|
|
3200
|
+
"strict": true,
|
|
3201
|
+
"enableJsonFlag": false,
|
|
3202
|
+
"authenticated": true,
|
|
3203
|
+
"primary": true,
|
|
3204
|
+
"isESM": false,
|
|
3205
|
+
"relativePath": [
|
|
3206
|
+
"build",
|
|
3207
|
+
"commands",
|
|
3208
|
+
"join",
|
|
3209
|
+
"index.js"
|
|
3210
|
+
]
|
|
3211
|
+
},
|
|
3212
3212
|
"logout": {
|
|
3213
3213
|
"aliases": [],
|
|
3214
3214
|
"args": {},
|
|
@@ -3258,6 +3258,136 @@
|
|
|
3258
3258
|
"list.js"
|
|
3259
3259
|
]
|
|
3260
3260
|
},
|
|
3261
|
+
"preload": {
|
|
3262
|
+
"aliases": [],
|
|
3263
|
+
"args": {
|
|
3264
|
+
"image": {
|
|
3265
|
+
"description": "the image file path",
|
|
3266
|
+
"name": "image",
|
|
3267
|
+
"required": true
|
|
3268
|
+
}
|
|
3269
|
+
},
|
|
3270
|
+
"description": "Preload a release on a disk image (or Edison zip archive).\n\nPreload a release (service images/containers) from a balena fleet, and optionally\na balenaOS splash screen, in a previously downloaded '.img' balenaOS image file\nin the local disk (a zip file is only accepted for the Intel Edison device type).\nAfter preloading, the balenaOS image file can be flashed to a device's SD card.\nWhen the device boots, it will not need to download the release, as it was\npreloaded. This is usually combined with release pinning\n(https://www.balena.io/docs/learn/deploy/release-strategy/release-policy/)\nto avoid the device downloading a newer release straight away, if available.\nCheck also the Preloading and Preregistering section of the balena CLI's advanced\nmasterclass document:\nhttps://www.balena.io/docs/learn/more/masterclasses/advanced-cli/#5-preloading-and-preregistering\n\nFleets may be specified by fleet name or slug. Fleet slugs are\nthe recommended option, as they are unique and unambiguous. Slugs can be\nlisted with the `balena fleet list` command. Note that slugs may change if the\nfleet is renamed. Fleet names are not unique and may result in \"Fleet is\nambiguous\" errors at any time (even if it \"used to work in the past\"), for\nexample if the name clashes with a newly created public fleet, or with fleets\nfrom other balena accounts that you may be invited to join under any role.\nFor this reason, fleet names are especially discouraged in scripts (e.g. CI\nenvironments).\n\nNote that the this command requires Docker to be installed, as further detailed\nin the balena CLI's installation instructions:\nhttps://github.com/balena-io/balena-cli/blob/master/INSTALL.md\nThe `--dockerHost` and `--dockerPort` flags allow a remote Docker engine to\nbe used, however the image file must be accessible to the remote Docker engine\non the same path given on the command line. This is because Docker's bind mount\nfeature is used to \"share\" the image with a container that performs the preload.",
|
|
3271
|
+
"examples": [
|
|
3272
|
+
"$ balena preload balena.img --fleet MyFleet --commit e1f2592fc6ee949e68756d4f4a48e49bff8d72a0",
|
|
3273
|
+
"$ balena preload balena.img --fleet myorg/myfleet --splash-image image.png",
|
|
3274
|
+
"$ balena preload balena.img"
|
|
3275
|
+
],
|
|
3276
|
+
"flags": {
|
|
3277
|
+
"fleet": {
|
|
3278
|
+
"char": "f",
|
|
3279
|
+
"description": "fleet name or slug (preferred)",
|
|
3280
|
+
"name": "fleet",
|
|
3281
|
+
"hasDynamicHelp": false,
|
|
3282
|
+
"multiple": false,
|
|
3283
|
+
"type": "option"
|
|
3284
|
+
},
|
|
3285
|
+
"commit": {
|
|
3286
|
+
"char": "c",
|
|
3287
|
+
"description": "The commit hash of the release to preload. Use \"current\" to specify the current\nrelease (ignored if no appId is given). The current release is usually also the\nlatest, but can be pinned to a specific release. See:\nhttps://www.balena.io/docs/learn/deploy/release-strategy/release-policy/\nhttps://www.balena.io/docs/learn/more/masterclasses/fleet-management/#63-pin-using-the-api\nhttps://github.com/balena-io-examples/staged-releases",
|
|
3288
|
+
"name": "commit",
|
|
3289
|
+
"hasDynamicHelp": false,
|
|
3290
|
+
"multiple": false,
|
|
3291
|
+
"type": "option"
|
|
3292
|
+
},
|
|
3293
|
+
"splash-image": {
|
|
3294
|
+
"char": "s",
|
|
3295
|
+
"description": "path to a png image to replace the splash screen",
|
|
3296
|
+
"name": "splash-image",
|
|
3297
|
+
"hasDynamicHelp": false,
|
|
3298
|
+
"multiple": false,
|
|
3299
|
+
"type": "option"
|
|
3300
|
+
},
|
|
3301
|
+
"dont-check-arch": {
|
|
3302
|
+
"description": "disable architecture compatibility check between image and fleet",
|
|
3303
|
+
"name": "dont-check-arch",
|
|
3304
|
+
"allowNo": false,
|
|
3305
|
+
"type": "boolean"
|
|
3306
|
+
},
|
|
3307
|
+
"pin-device-to-release": {
|
|
3308
|
+
"char": "p",
|
|
3309
|
+
"description": "pin the preloaded device to the preloaded release on provision",
|
|
3310
|
+
"name": "pin-device-to-release",
|
|
3311
|
+
"allowNo": true,
|
|
3312
|
+
"type": "boolean"
|
|
3313
|
+
},
|
|
3314
|
+
"additional-space": {
|
|
3315
|
+
"description": "expand the image by this amount of bytes instead of automatically estimating the required amount",
|
|
3316
|
+
"name": "additional-space",
|
|
3317
|
+
"hasDynamicHelp": false,
|
|
3318
|
+
"multiple": false,
|
|
3319
|
+
"type": "option"
|
|
3320
|
+
},
|
|
3321
|
+
"add-certificate": {
|
|
3322
|
+
"description": "Add the given certificate (in PEM format) to /etc/ssl/certs in the preloading container.\nThe file name must end with '.crt' and must not be already contained in the preloader's\n/etc/ssl/certs folder.\nCan be repeated to add multiple certificates.",
|
|
3323
|
+
"name": "add-certificate",
|
|
3324
|
+
"hasDynamicHelp": false,
|
|
3325
|
+
"multiple": true,
|
|
3326
|
+
"type": "option"
|
|
3327
|
+
},
|
|
3328
|
+
"docker": {
|
|
3329
|
+
"char": "P",
|
|
3330
|
+
"description": "Path to a local docker socket (e.g. /var/run/docker.sock)",
|
|
3331
|
+
"name": "docker",
|
|
3332
|
+
"hasDynamicHelp": false,
|
|
3333
|
+
"multiple": false,
|
|
3334
|
+
"type": "option"
|
|
3335
|
+
},
|
|
3336
|
+
"dockerHost": {
|
|
3337
|
+
"char": "h",
|
|
3338
|
+
"description": "Docker daemon hostname or IP address (dev machine or balena device) ",
|
|
3339
|
+
"name": "dockerHost",
|
|
3340
|
+
"hasDynamicHelp": false,
|
|
3341
|
+
"multiple": false,
|
|
3342
|
+
"type": "option"
|
|
3343
|
+
},
|
|
3344
|
+
"dockerPort": {
|
|
3345
|
+
"description": "Docker daemon TCP port number (hint: 2375 for balena devices)",
|
|
3346
|
+
"name": "dockerPort",
|
|
3347
|
+
"hasDynamicHelp": false,
|
|
3348
|
+
"multiple": false,
|
|
3349
|
+
"type": "option"
|
|
3350
|
+
},
|
|
3351
|
+
"ca": {
|
|
3352
|
+
"description": "Docker host TLS certificate authority file",
|
|
3353
|
+
"name": "ca",
|
|
3354
|
+
"hasDynamicHelp": false,
|
|
3355
|
+
"multiple": false,
|
|
3356
|
+
"type": "option"
|
|
3357
|
+
},
|
|
3358
|
+
"cert": {
|
|
3359
|
+
"description": "Docker host TLS certificate file",
|
|
3360
|
+
"name": "cert",
|
|
3361
|
+
"hasDynamicHelp": false,
|
|
3362
|
+
"multiple": false,
|
|
3363
|
+
"type": "option"
|
|
3364
|
+
},
|
|
3365
|
+
"key": {
|
|
3366
|
+
"description": "Docker host TLS key file",
|
|
3367
|
+
"name": "key",
|
|
3368
|
+
"hasDynamicHelp": false,
|
|
3369
|
+
"multiple": false,
|
|
3370
|
+
"type": "option"
|
|
3371
|
+
}
|
|
3372
|
+
},
|
|
3373
|
+
"hasDynamicHelp": false,
|
|
3374
|
+
"hiddenAliases": [],
|
|
3375
|
+
"id": "preload",
|
|
3376
|
+
"pluginAlias": "balena-cli",
|
|
3377
|
+
"pluginName": "balena-cli",
|
|
3378
|
+
"pluginType": "core",
|
|
3379
|
+
"strict": true,
|
|
3380
|
+
"enableJsonFlag": false,
|
|
3381
|
+
"authenticated": true,
|
|
3382
|
+
"primary": true,
|
|
3383
|
+
"isESM": false,
|
|
3384
|
+
"relativePath": [
|
|
3385
|
+
"build",
|
|
3386
|
+
"commands",
|
|
3387
|
+
"preload",
|
|
3388
|
+
"index.js"
|
|
3389
|
+
]
|
|
3390
|
+
},
|
|
3261
3391
|
"os:configure": {
|
|
3262
3392
|
"aliases": [],
|
|
3263
3393
|
"args": {
|
|
@@ -3597,136 +3727,6 @@
|
|
|
3597
3727
|
"versions.js"
|
|
3598
3728
|
]
|
|
3599
3729
|
},
|
|
3600
|
-
"preload": {
|
|
3601
|
-
"aliases": [],
|
|
3602
|
-
"args": {
|
|
3603
|
-
"image": {
|
|
3604
|
-
"description": "the image file path",
|
|
3605
|
-
"name": "image",
|
|
3606
|
-
"required": true
|
|
3607
|
-
}
|
|
3608
|
-
},
|
|
3609
|
-
"description": "Preload a release on a disk image (or Edison zip archive).\n\nPreload a release (service images/containers) from a balena fleet, and optionally\na balenaOS splash screen, in a previously downloaded '.img' balenaOS image file\nin the local disk (a zip file is only accepted for the Intel Edison device type).\nAfter preloading, the balenaOS image file can be flashed to a device's SD card.\nWhen the device boots, it will not need to download the release, as it was\npreloaded. This is usually combined with release pinning\n(https://www.balena.io/docs/learn/deploy/release-strategy/release-policy/)\nto avoid the device downloading a newer release straight away, if available.\nCheck also the Preloading and Preregistering section of the balena CLI's advanced\nmasterclass document:\nhttps://www.balena.io/docs/learn/more/masterclasses/advanced-cli/#5-preloading-and-preregistering\n\nFleets may be specified by fleet name or slug. Fleet slugs are\nthe recommended option, as they are unique and unambiguous. Slugs can be\nlisted with the `balena fleet list` command. Note that slugs may change if the\nfleet is renamed. Fleet names are not unique and may result in \"Fleet is\nambiguous\" errors at any time (even if it \"used to work in the past\"), for\nexample if the name clashes with a newly created public fleet, or with fleets\nfrom other balena accounts that you may be invited to join under any role.\nFor this reason, fleet names are especially discouraged in scripts (e.g. CI\nenvironments).\n\nNote that the this command requires Docker to be installed, as further detailed\nin the balena CLI's installation instructions:\nhttps://github.com/balena-io/balena-cli/blob/master/INSTALL.md\nThe `--dockerHost` and `--dockerPort` flags allow a remote Docker engine to\nbe used, however the image file must be accessible to the remote Docker engine\non the same path given on the command line. This is because Docker's bind mount\nfeature is used to \"share\" the image with a container that performs the preload.",
|
|
3610
|
-
"examples": [
|
|
3611
|
-
"$ balena preload balena.img --fleet MyFleet --commit e1f2592fc6ee949e68756d4f4a48e49bff8d72a0",
|
|
3612
|
-
"$ balena preload balena.img --fleet myorg/myfleet --splash-image image.png",
|
|
3613
|
-
"$ balena preload balena.img"
|
|
3614
|
-
],
|
|
3615
|
-
"flags": {
|
|
3616
|
-
"fleet": {
|
|
3617
|
-
"char": "f",
|
|
3618
|
-
"description": "fleet name or slug (preferred)",
|
|
3619
|
-
"name": "fleet",
|
|
3620
|
-
"hasDynamicHelp": false,
|
|
3621
|
-
"multiple": false,
|
|
3622
|
-
"type": "option"
|
|
3623
|
-
},
|
|
3624
|
-
"commit": {
|
|
3625
|
-
"char": "c",
|
|
3626
|
-
"description": "The commit hash of the release to preload. Use \"current\" to specify the current\nrelease (ignored if no appId is given). The current release is usually also the\nlatest, but can be pinned to a specific release. See:\nhttps://www.balena.io/docs/learn/deploy/release-strategy/release-policy/\nhttps://www.balena.io/docs/learn/more/masterclasses/fleet-management/#63-pin-using-the-api\nhttps://github.com/balena-io-examples/staged-releases",
|
|
3627
|
-
"name": "commit",
|
|
3628
|
-
"hasDynamicHelp": false,
|
|
3629
|
-
"multiple": false,
|
|
3630
|
-
"type": "option"
|
|
3631
|
-
},
|
|
3632
|
-
"splash-image": {
|
|
3633
|
-
"char": "s",
|
|
3634
|
-
"description": "path to a png image to replace the splash screen",
|
|
3635
|
-
"name": "splash-image",
|
|
3636
|
-
"hasDynamicHelp": false,
|
|
3637
|
-
"multiple": false,
|
|
3638
|
-
"type": "option"
|
|
3639
|
-
},
|
|
3640
|
-
"dont-check-arch": {
|
|
3641
|
-
"description": "disable architecture compatibility check between image and fleet",
|
|
3642
|
-
"name": "dont-check-arch",
|
|
3643
|
-
"allowNo": false,
|
|
3644
|
-
"type": "boolean"
|
|
3645
|
-
},
|
|
3646
|
-
"pin-device-to-release": {
|
|
3647
|
-
"char": "p",
|
|
3648
|
-
"description": "pin the preloaded device to the preloaded release on provision",
|
|
3649
|
-
"name": "pin-device-to-release",
|
|
3650
|
-
"allowNo": true,
|
|
3651
|
-
"type": "boolean"
|
|
3652
|
-
},
|
|
3653
|
-
"additional-space": {
|
|
3654
|
-
"description": "expand the image by this amount of bytes instead of automatically estimating the required amount",
|
|
3655
|
-
"name": "additional-space",
|
|
3656
|
-
"hasDynamicHelp": false,
|
|
3657
|
-
"multiple": false,
|
|
3658
|
-
"type": "option"
|
|
3659
|
-
},
|
|
3660
|
-
"add-certificate": {
|
|
3661
|
-
"description": "Add the given certificate (in PEM format) to /etc/ssl/certs in the preloading container.\nThe file name must end with '.crt' and must not be already contained in the preloader's\n/etc/ssl/certs folder.\nCan be repeated to add multiple certificates.",
|
|
3662
|
-
"name": "add-certificate",
|
|
3663
|
-
"hasDynamicHelp": false,
|
|
3664
|
-
"multiple": true,
|
|
3665
|
-
"type": "option"
|
|
3666
|
-
},
|
|
3667
|
-
"docker": {
|
|
3668
|
-
"char": "P",
|
|
3669
|
-
"description": "Path to a local docker socket (e.g. /var/run/docker.sock)",
|
|
3670
|
-
"name": "docker",
|
|
3671
|
-
"hasDynamicHelp": false,
|
|
3672
|
-
"multiple": false,
|
|
3673
|
-
"type": "option"
|
|
3674
|
-
},
|
|
3675
|
-
"dockerHost": {
|
|
3676
|
-
"char": "h",
|
|
3677
|
-
"description": "Docker daemon hostname or IP address (dev machine or balena device) ",
|
|
3678
|
-
"name": "dockerHost",
|
|
3679
|
-
"hasDynamicHelp": false,
|
|
3680
|
-
"multiple": false,
|
|
3681
|
-
"type": "option"
|
|
3682
|
-
},
|
|
3683
|
-
"dockerPort": {
|
|
3684
|
-
"description": "Docker daemon TCP port number (hint: 2375 for balena devices)",
|
|
3685
|
-
"name": "dockerPort",
|
|
3686
|
-
"hasDynamicHelp": false,
|
|
3687
|
-
"multiple": false,
|
|
3688
|
-
"type": "option"
|
|
3689
|
-
},
|
|
3690
|
-
"ca": {
|
|
3691
|
-
"description": "Docker host TLS certificate authority file",
|
|
3692
|
-
"name": "ca",
|
|
3693
|
-
"hasDynamicHelp": false,
|
|
3694
|
-
"multiple": false,
|
|
3695
|
-
"type": "option"
|
|
3696
|
-
},
|
|
3697
|
-
"cert": {
|
|
3698
|
-
"description": "Docker host TLS certificate file",
|
|
3699
|
-
"name": "cert",
|
|
3700
|
-
"hasDynamicHelp": false,
|
|
3701
|
-
"multiple": false,
|
|
3702
|
-
"type": "option"
|
|
3703
|
-
},
|
|
3704
|
-
"key": {
|
|
3705
|
-
"description": "Docker host TLS key file",
|
|
3706
|
-
"name": "key",
|
|
3707
|
-
"hasDynamicHelp": false,
|
|
3708
|
-
"multiple": false,
|
|
3709
|
-
"type": "option"
|
|
3710
|
-
}
|
|
3711
|
-
},
|
|
3712
|
-
"hasDynamicHelp": false,
|
|
3713
|
-
"hiddenAliases": [],
|
|
3714
|
-
"id": "preload",
|
|
3715
|
-
"pluginAlias": "balena-cli",
|
|
3716
|
-
"pluginName": "balena-cli",
|
|
3717
|
-
"pluginType": "core",
|
|
3718
|
-
"strict": true,
|
|
3719
|
-
"enableJsonFlag": false,
|
|
3720
|
-
"authenticated": true,
|
|
3721
|
-
"primary": true,
|
|
3722
|
-
"isESM": false,
|
|
3723
|
-
"relativePath": [
|
|
3724
|
-
"build",
|
|
3725
|
-
"commands",
|
|
3726
|
-
"preload",
|
|
3727
|
-
"index.js"
|
|
3728
|
-
]
|
|
3729
|
-
},
|
|
3730
3730
|
"push": {
|
|
3731
3731
|
"aliases": [],
|
|
3732
3732
|
"args": {
|
|
@@ -4777,5 +4777,5 @@
|
|
|
4777
4777
|
]
|
|
4778
4778
|
}
|
|
4779
4779
|
},
|
|
4780
|
-
"version": "23.1.
|
|
4780
|
+
"version": "23.1.2"
|
|
4781
4781
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "balena-cli",
|
|
3
|
-
"version": "23.1.1",
|
|
3
|
+
"version": "23.1.2-build-remove-help-patch-149117ec0c36346e2eadac5823d0cacbb5a40349-1",
|
|
4
4
|
"description": "The official balena Command Line Interface",
|
|
5
5
|
"main": "./build/app.js",
|
|
6
6
|
"homepage": "https://github.com/balena-io/balena-cli",
|
|
@@ -262,6 +262,6 @@
|
|
|
262
262
|
"balena-request": "14.0.6"
|
|
263
263
|
},
|
|
264
264
|
"versionist": {
|
|
265
|
-
"publishedAt": "2025-11-
|
|
265
|
+
"publishedAt": "2025-11-18T15:00:10.273Z"
|
|
266
266
|
}
|
|
267
267
|
}
|
|
@@ -1,22 +1,3 @@
|
|
|
1
|
-
diff --git a/node_modules/@oclif/core/lib/help/index.js b/node_modules/@oclif/core/lib/help/index.js
|
|
2
|
-
index 5846c71..d47d146 100644
|
|
3
|
-
--- a/node_modules/@oclif/core/lib/help/index.js
|
|
4
|
-
+++ b/node_modules/@oclif/core/lib/help/index.js
|
|
5
|
-
@@ -186,11 +186,12 @@ class Help extends HelpBase {
|
|
6
|
-
}
|
|
7
|
-
this.log(this.formatCommand(command));
|
|
8
|
-
this.log('');
|
|
9
|
-
- if (subTopics.length > 0) {
|
|
10
|
-
+ const SUPPRESS_SUBTOPICS = true;
|
|
11
|
-
+ if (subTopics.length > 0 && !SUPPRESS_SUBTOPICS) {
|
|
12
|
-
this.log(this.formatTopics(subTopics));
|
|
13
|
-
this.log('');
|
|
14
|
-
}
|
|
15
|
-
- if (subCommands.length > 0) {
|
|
16
|
-
+ if (subCommands.length > 0 && !SUPPRESS_SUBTOPICS) {
|
|
17
|
-
const aliases = [];
|
|
18
|
-
const uniqueSubCommands = subCommands.filter((p) => {
|
|
19
|
-
aliases.push(...p.aliases);
|
|
20
1
|
diff --git a/node_modules/@oclif/core/lib/parser/errors.js b/node_modules/@oclif/core/lib/parser/errors.js
|
|
21
2
|
index 168da99..538a880 100644
|
|
22
3
|
--- a/node_modules/@oclif/core/lib/parser/errors.js
|
package/src/help.ts
CHANGED
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
* See the License for the specific language governing permissions and
|
|
15
15
|
* limitations under the License.
|
|
16
16
|
*/
|
|
17
|
-
import type { Command } from '@oclif/core';
|
|
17
|
+
import type { Command, Interfaces } from '@oclif/core';
|
|
18
18
|
import { Help } from '@oclif/core';
|
|
19
19
|
import * as indent from 'indent-string';
|
|
20
20
|
import type { ResolvableReturnType } from 'balena-sdk/typings/utils';
|
|
@@ -39,6 +39,36 @@ function getHelpSubject(args: string[]): string | undefined {
|
|
|
39
39
|
}
|
|
40
40
|
|
|
41
41
|
export default class BalenaHelp extends Help {
|
|
42
|
+
private SUPPRESS_SUBTOPICS_DEPTH: number | null = null;
|
|
43
|
+
|
|
44
|
+
protected get sortedCommands(): Command.Loadable[] {
|
|
45
|
+
const commands = super.sortedCommands;
|
|
46
|
+
if (this.SUPPRESS_SUBTOPICS_DEPTH == null) {
|
|
47
|
+
return commands;
|
|
48
|
+
}
|
|
49
|
+
// Assign it to a const so that TS knows that this can't change to null during the .filter
|
|
50
|
+
const depth = this.SUPPRESS_SUBTOPICS_DEPTH;
|
|
51
|
+
return commands.filter((c) => c.id.split(':').length <= depth);
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
protected get sortedTopics(): Interfaces.Topic[] {
|
|
55
|
+
const topics = super.sortedTopics;
|
|
56
|
+
if (this.SUPPRESS_SUBTOPICS_DEPTH == null) {
|
|
57
|
+
return topics;
|
|
58
|
+
}
|
|
59
|
+
// Assign it to a const so that TS knows that this can't change to null during the .filter
|
|
60
|
+
const depth = this.SUPPRESS_SUBTOPICS_DEPTH;
|
|
61
|
+
return topics.filter((t) => t.name.split(':').length <= depth);
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
public async showCommandHelp(command: Command.Loadable): Promise<void> {
|
|
65
|
+
const name = command.id;
|
|
66
|
+
const depth = name.split(':').length;
|
|
67
|
+
this.SUPPRESS_SUBTOPICS_DEPTH = depth;
|
|
68
|
+
await super.showCommandHelp(command);
|
|
69
|
+
this.SUPPRESS_SUBTOPICS_DEPTH = null;
|
|
70
|
+
}
|
|
71
|
+
|
|
42
72
|
public async showHelp(argv: string[]) {
|
|
43
73
|
const ux = getCliUx();
|
|
44
74
|
const subject = getHelpSubject(argv);
|