@fnndsc/brasa 0.56.3 → 0.57.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/dist/buildinfo.json +1 -1
- package/dist/builtins/argumentTokens.d.ts +13 -0
- package/dist/builtins/argumentTokens.js +15 -3
- package/dist/builtins/argumentTokens.js.map +1 -1
- package/dist/builtins/berth/berth.d.ts +11 -0
- package/dist/builtins/berth/berth.js +53 -22
- package/dist/builtins/berth/berth.js.map +1 -1
- package/dist/builtins/berth/berthCube.d.ts +14 -0
- package/dist/builtins/berth/berthCube.js +17 -0
- package/dist/builtins/berth/berthCube.js.map +1 -1
- package/dist/builtins/fs/download.d.ts +12 -1
- package/dist/builtins/fs/download.js +24 -4
- package/dist/builtins/fs/download.js.map +1 -1
- package/dist/builtins/fs/transferJobs.d.ts +64 -0
- package/dist/builtins/fs/transferJobs.js +98 -0
- package/dist/builtins/fs/transferJobs.js.map +1 -0
- package/dist/builtins/fs/upload.d.ts +14 -1
- package/dist/builtins/fs/upload.js +22 -5
- package/dist/builtins/fs/upload.js.map +1 -1
- package/dist/builtins/fs/url.d.ts +27 -2
- package/dist/builtins/fs/url.js +60 -10
- package/dist/builtins/fs/url.js.map +1 -1
- package/dist/builtins/help.d.ts +6 -10
- package/dist/builtins/help.js +34 -87
- package/dist/builtins/help.js.map +1 -1
- package/dist/builtins/helpSections.js +4 -1
- package/dist/builtins/helpSections.js.map +1 -1
- package/dist/builtins/pluginExecute.d.ts +21 -3
- package/dist/builtins/pluginExecute.js +69 -33
- package/dist/builtins/pluginExecute.js.map +1 -1
- package/dist/builtins/res/pipeline.d.ts +231 -2
- package/dist/builtins/res/pipeline.js +225 -107
- package/dist/builtins/res/pipeline.js.map +1 -1
- package/dist/builtins/res/plugin.d.ts +343 -3
- package/dist/builtins/res/plugin.js +221 -67
- package/dist/builtins/res/plugin.js.map +1 -1
- package/dist/builtins/res/plugin.sync.js +5 -3
- package/dist/builtins/res/plugin.sync.js.map +1 -1
- package/dist/chris/binDeclarations.d.ts +312 -0
- package/dist/chris/binDeclarations.js +572 -0
- package/dist/chris/binDeclarations.js.map +1 -0
- package/dist/chris/chrisCommands.d.ts +1 -0
- package/dist/chris/chrisCommands.js +5 -30
- package/dist/chris/chrisCommands.js.map +1 -1
- package/dist/chris/commandFallback.d.ts +30 -3
- package/dist/chris/commandFallback.js +163 -94
- package/dist/chris/commandFallback.js.map +1 -1
- package/dist/chris/completion.d.ts +37 -0
- package/dist/chris/completion.js +41 -121
- package/dist/chris/completion.js.map +1 -1
- package/dist/chris/kinds.d.ts +11 -0
- package/dist/chris/kinds.js +32 -1
- package/dist/chris/kinds.js.map +1 -1
- package/dist/core/argumentKinds.d.ts +18 -0
- package/dist/core/argumentKinds.js +33 -0
- package/dist/core/argumentKinds.js.map +1 -1
- package/dist/core/backend.d.ts +12 -5
- package/dist/core/backend.js.map +1 -1
- package/dist/core/commandDeclaration.d.ts +40 -0
- package/dist/core/commandDeclaration.js.map +1 -1
- package/dist/core/commandOrder.js +3 -3
- package/dist/core/commandOrder.js.map +1 -1
- package/dist/core/commandParse.d.ts +14 -0
- package/dist/core/commandParse.js +39 -5
- package/dist/core/commandParse.js.map +1 -1
- package/dist/core/commandRegistry.d.ts +22 -36
- package/dist/core/commandRegistry.js +19 -10
- package/dist/core/commandRegistry.js.map +1 -1
- package/dist/core/commandSchema.js +4 -0
- package/dist/core/commandSchema.js.map +1 -1
- package/dist/core/coreCommands.d.ts +1 -0
- package/dist/core/coreCommands.js +6 -19
- package/dist/core/coreCommands.js.map +1 -1
- package/dist/core/dispatch.js +12 -41
- package/dist/core/dispatch.js.map +1 -1
- package/dist/core/preprocess.d.ts +0 -15
- package/dist/core/preprocess.js +0 -17
- package/dist/core/preprocess.js.map +1 -1
- package/dist/core/shellWords.d.ts +34 -0
- package/dist/core/shellWords.js +60 -0
- package/dist/core/shellWords.js.map +1 -0
- package/dist/core.d.ts +5 -0
- package/dist/core.js +4 -0
- package/dist/core.js.map +1 -1
- package/dist/lib/completer/declared.js +22 -6
- package/dist/lib/completer/declared.js.map +1 -1
- package/dist/lib/completer/index.js +15 -53
- package/dist/lib/completer/index.js.map +1 -1
- package/dist/notes.json +1 -1
- package/package.json +5 -5
- package/dist/builtins/res/pipeline.args.d.ts +0 -35
- package/dist/builtins/res/pipeline.args.js +0 -94
- package/dist/builtins/res/pipeline.args.js.map +0 -1
- package/dist/chris/help.d.ts +0 -18
- package/dist/chris/help.js +0 -229
- package/dist/chris/help.js.map +0 -1
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@fnndsc/brasa",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.57.0",
|
|
4
4
|
"description": "BRASA Runs Abstracted Shell Actions - the hostable ChRIS shell engine (kernel)",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -48,10 +48,10 @@
|
|
|
48
48
|
"author": "FNNDSC <dev@babyMRI.org>",
|
|
49
49
|
"license": "MIT",
|
|
50
50
|
"dependencies": {
|
|
51
|
-
"@fnndsc/chili": "^3.9.
|
|
52
|
-
"@fnndsc/fond": "^0.6.
|
|
53
|
-
"@fnndsc/cumin": "^3.30.
|
|
54
|
-
"@fnndsc/salsa": "^4.5.
|
|
51
|
+
"@fnndsc/chili": "^3.9.5",
|
|
52
|
+
"@fnndsc/fond": "^0.6.2",
|
|
53
|
+
"@fnndsc/cumin": "^3.30.6",
|
|
54
|
+
"@fnndsc/salsa": "^4.5.5",
|
|
55
55
|
"bsd-trek": "^0.4.0",
|
|
56
56
|
"chalk": "^4.1.2",
|
|
57
57
|
"cli-highlight": "^2.1.11",
|
|
@@ -1,35 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* @file Pure argument parsing for the `pipeline run` subcommand.
|
|
3
|
-
*
|
|
4
|
-
* Dependency-free for easy unit testing.
|
|
5
|
-
*
|
|
6
|
-
* @module
|
|
7
|
-
*/
|
|
8
|
-
import type { PipelineInvocationBinding } from '@fnndsc/salsa';
|
|
9
|
-
/**
|
|
10
|
-
* Optional overrides parsed from `pipeline run` arguments.
|
|
11
|
-
*/
|
|
12
|
-
export interface PipelineRunOverrides {
|
|
13
|
-
computeOverride: string | undefined;
|
|
14
|
-
previousOverride: number | undefined;
|
|
15
|
-
paramFile: string | undefined;
|
|
16
|
-
bindings: PipelineInvocationBinding[];
|
|
17
|
-
/** Whether the operator asked for the handle rather than the outcome. */
|
|
18
|
-
detach: boolean;
|
|
19
|
-
/** Whether the echo of the resolved call lists every parameter of every piping. */
|
|
20
|
-
verbose: boolean;
|
|
21
|
-
/** Whether the run is resolved and printed only (`whatif`). */
|
|
22
|
-
dry: boolean;
|
|
23
|
-
/** A dry run on a feed that would be rooted first, so no node exists to attach to. */
|
|
24
|
-
dryNewFeed: boolean;
|
|
25
|
-
parseError: string | null;
|
|
26
|
-
}
|
|
27
|
-
/**
|
|
28
|
-
* Parses `--compute <resource>`, `--previous <inst_id>`, `--paramFile <path>`
|
|
29
|
-
* `--detach`, `--verbose` and `--whatif` from `pipeline run <name|id> ...` arguments (scanning from
|
|
30
|
-
* index 2). Anything else in `--node.field value` form is a binding.
|
|
31
|
-
*
|
|
32
|
-
* @param args - The full `pipeline run` argument list.
|
|
33
|
-
* @returns The parsed overrides.
|
|
34
|
-
*/
|
|
35
|
-
export declare function pipelineRunArgs_parse(args: string[]): PipelineRunOverrides;
|
|
@@ -1,94 +0,0 @@
|
|
|
1
|
-
import { executableArguments_parse } from '../argumentTokens.js';
|
|
2
|
-
/**
|
|
3
|
-
* Parses `--compute <resource>`, `--previous <inst_id>`, `--paramFile <path>`
|
|
4
|
-
* `--detach`, `--verbose` and `--whatif` from `pipeline run <name|id> ...` arguments (scanning from
|
|
5
|
-
* index 2). Anything else in `--node.field value` form is a binding.
|
|
6
|
-
*
|
|
7
|
-
* @param args - The full `pipeline run` argument list.
|
|
8
|
-
* @returns The parsed overrides.
|
|
9
|
-
*/
|
|
10
|
-
export function pipelineRunArgs_parse(args) {
|
|
11
|
-
let computeOverride;
|
|
12
|
-
let previousOverride;
|
|
13
|
-
let paramFile;
|
|
14
|
-
const bindings = [];
|
|
15
|
-
let detach = false;
|
|
16
|
-
let verbose = false;
|
|
17
|
-
let dry = false;
|
|
18
|
-
let dryNewFeed = false;
|
|
19
|
-
let parseError = null;
|
|
20
|
-
for (let i = 2; i < args.length; i++) {
|
|
21
|
-
const token = args[i];
|
|
22
|
-
if (token === '--compute') {
|
|
23
|
-
const value = args[i + 1];
|
|
24
|
-
if (value === undefined || value.startsWith('--')) {
|
|
25
|
-
parseError = '--compute requires a resource';
|
|
26
|
-
break;
|
|
27
|
-
}
|
|
28
|
-
computeOverride = value;
|
|
29
|
-
i++;
|
|
30
|
-
}
|
|
31
|
-
else if (token === '--previous') {
|
|
32
|
-
const value = args[i + 1];
|
|
33
|
-
if (value === undefined || !/^\d+$/.test(value)) {
|
|
34
|
-
parseError = '--previous requires a positive plugin instance ID';
|
|
35
|
-
break;
|
|
36
|
-
}
|
|
37
|
-
previousOverride = Number(value);
|
|
38
|
-
i++;
|
|
39
|
-
}
|
|
40
|
-
else if (token === '--detach') {
|
|
41
|
-
detach = true;
|
|
42
|
-
}
|
|
43
|
-
else if (token === '--verbose') {
|
|
44
|
-
verbose = true;
|
|
45
|
-
}
|
|
46
|
-
else if (token === '--whatif' || token === '--whatif-new-feed') {
|
|
47
|
-
dry = true;
|
|
48
|
-
dryNewFeed ||= token === '--whatif-new-feed';
|
|
49
|
-
}
|
|
50
|
-
else if (token === '--paramFile') {
|
|
51
|
-
const value = args[i + 1];
|
|
52
|
-
if (paramFile !== undefined) {
|
|
53
|
-
parseError = '--paramFile may be supplied only once';
|
|
54
|
-
break;
|
|
55
|
-
}
|
|
56
|
-
if (value === undefined || value.startsWith('--')) {
|
|
57
|
-
parseError = '--paramFile requires a CFS path';
|
|
58
|
-
break;
|
|
59
|
-
}
|
|
60
|
-
paramFile = value;
|
|
61
|
-
i++;
|
|
62
|
-
}
|
|
63
|
-
else if (token.startsWith('--')) {
|
|
64
|
-
const option = token.slice(2);
|
|
65
|
-
const equalsIndex = option.indexOf('=');
|
|
66
|
-
const compound = equalsIndex === -1 ? option : option.slice(0, equalsIndex);
|
|
67
|
-
const separator = compound.lastIndexOf('.');
|
|
68
|
-
if (separator <= 0 || separator === compound.length - 1) {
|
|
69
|
-
parseError = `unsupported pipeline option: ${token}`;
|
|
70
|
-
break;
|
|
71
|
-
}
|
|
72
|
-
const node = compound.slice(0, separator);
|
|
73
|
-
const field = compound.slice(separator + 1);
|
|
74
|
-
let value;
|
|
75
|
-
if (equalsIndex >= 0) {
|
|
76
|
-
value = executableArguments_parse([`--${field}=${option.slice(equalsIndex + 1)}`])[field];
|
|
77
|
-
}
|
|
78
|
-
else {
|
|
79
|
-
const next = args[i + 1];
|
|
80
|
-
const consumesNext = next !== undefined && (!next.startsWith('--') || /^-\d/.test(next));
|
|
81
|
-
value = executableArguments_parse(consumesNext ? [`--${field}`, next] : [`--${field}`])[field];
|
|
82
|
-
if (consumesNext)
|
|
83
|
-
i++;
|
|
84
|
-
}
|
|
85
|
-
bindings.push({ node, field, value });
|
|
86
|
-
}
|
|
87
|
-
else {
|
|
88
|
-
parseError = `unexpected pipeline argument: ${token}`;
|
|
89
|
-
break;
|
|
90
|
-
}
|
|
91
|
-
}
|
|
92
|
-
return { computeOverride, previousOverride, paramFile, bindings, detach, verbose, dry, dryNewFeed, parseError };
|
|
93
|
-
}
|
|
94
|
-
//# sourceMappingURL=pipeline.args.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"pipeline.args.js","sourceRoot":"","sources":["../../../src/builtins/res/pipeline.args.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,yBAAyB,EAAE,MAAM,sBAAsB,CAAC;AAqBjE;;;;;;;GAOG;AACH,MAAM,UAAU,qBAAqB,CAAC,IAAc;IAClD,IAAI,eAAmC,CAAC;IACxC,IAAI,gBAAoC,CAAC;IACzC,IAAI,SAA6B,CAAC;IAClC,MAAM,QAAQ,GAAgC,EAAE,CAAC;IACjD,IAAI,MAAM,GAAY,KAAK,CAAC;IAC5B,IAAI,OAAO,GAAY,KAAK,CAAC;IAC7B,IAAI,GAAG,GAAY,KAAK,CAAC;IACzB,IAAI,UAAU,GAAY,KAAK,CAAC;IAChC,IAAI,UAAU,GAAkB,IAAI,CAAC;IAErC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACrC,MAAM,KAAK,GAAW,IAAI,CAAC,CAAC,CAAC,CAAC;QAC9B,IAAI,KAAK,KAAK,WAAW,EAAE,CAAC;YAC1B,MAAM,KAAK,GAAuB,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YAC9C,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;gBAClD,UAAU,GAAG,+BAA+B,CAAC;gBAC7C,MAAM;YACR,CAAC;YACD,eAAe,GAAG,KAAK,CAAC;YACxB,CAAC,EAAE,CAAC;QACN,CAAC;aAAM,IAAI,KAAK,KAAK,YAAY,EAAE,CAAC;YAClC,MAAM,KAAK,GAAuB,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YAC9C,IAAI,KAAK,KAAK,SAAS,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;gBAChD,UAAU,GAAG,mDAAmD,CAAC;gBACjE,MAAM;YACR,CAAC;YACD,gBAAgB,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;YACjC,CAAC,EAAE,CAAC;QACN,CAAC;aAAM,IAAI,KAAK,KAAK,UAAU,EAAE,CAAC;YAChC,MAAM,GAAG,IAAI,CAAC;QAChB,CAAC;aAAM,IAAI,KAAK,KAAK,WAAW,EAAE,CAAC;YACjC,OAAO,GAAG,IAAI,CAAC;QACjB,CAAC;aAAM,IAAI,KAAK,KAAK,UAAU,IAAI,KAAK,KAAK,mBAAmB,EAAE,CAAC;YACjE,GAAG,GAAG,IAAI,CAAC;YACX,UAAU,KAAK,KAAK,KAAK,mBAAmB,CAAC;QAC/C,CAAC;aAAM,IAAI,KAAK,KAAK,aAAa,EAAE,CAAC;YACnC,MAAM,KAAK,GAAuB,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YAC9C,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;gBAC5B,UAAU,GAAG,uCAAuC,CAAC;gBACrD,MAAM;YACR,CAAC;YACD,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;gBAClD,UAAU,GAAG,iCAAiC,CAAC;gBAC/C,MAAM;YACR,CAAC;YACD,SAAS,GAAG,KAAK,CAAC;YAClB,CAAC,EAAE,CAAC;QACN,CAAC;aAAM,IAAI,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;YAClC,MAAM,MAAM,GAAW,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YACtC,MAAM,WAAW,GAAW,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAChD,MAAM,QAAQ,GAAW,WAAW,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC;YACpF,MAAM,SAAS,GAAW,QAAQ,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;YACpD,IAAI,SAAS,IAAI,CAAC,IAAI,SAAS,KAAK,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACxD,UAAU,GAAG,gCAAgC,KAAK,EAAE,CAAC;gBACrD,MAAM;YACR,CAAC;YACD,MAAM,IAAI,GAAW,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC;YAClD,MAAM,KAAK,GAAW,QAAQ,CAAC,KAAK,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC;YACpD,IAAI,KAAc,CAAC;YACnB,IAAI,WAAW,IAAI,CAAC,EAAE,CAAC;gBACrB,KAAK,GAAG,yBAAyB,CAAC,CAAC,KAAK,KAAK,IAAI,MAAM,CAAC,KAAK,CAAC,WAAW,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;YAC5F,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,GAAuB,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;gBAC7C,MAAM,YAAY,GAAY,IAAI,KAAK,SAAS,IAAI,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;gBAClG,KAAK,GAAG,yBAAyB,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,KAAK,KAAK,EAAE,EAAE,IAAc,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;gBACzG,IAAI,YAAY;oBAAE,CAAC,EAAE,CAAC;YACxB,CAAC;YACD,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;QACxC,CAAC;aAAM,CAAC;YACN,UAAU,GAAG,iCAAiC,KAAK,EAAE,CAAC;YACtD,MAAM;QACR,CAAC;IACH,CAAC;IAED,OAAO,EAAE,eAAe,EAAE,gBAAgB,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,UAAU,EAAE,UAAU,EAAE,CAAC;AAClH,CAAC"}
|
package/dist/chris/help.d.ts
DELETED
|
@@ -1,18 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* @file The ChRIS backend's help: a page for each command it registers.
|
|
3
|
-
*
|
|
4
|
-
* The core's own commands keep their pages in `builtins/help.ts`; these are
|
|
5
|
-
* registered with the ChRIS commands, so a session without ChRIS has none.
|
|
6
|
-
*
|
|
7
|
-
* @module
|
|
8
|
-
*/
|
|
9
|
-
import type { CommandHelp } from '../core/commandRegistry.js';
|
|
10
|
-
/**
|
|
11
|
-
* Standard subcommands and options injected into every resource help entry.
|
|
12
|
-
* Captures the Resource Contract documented in CONTEXT.md.
|
|
13
|
-
*/
|
|
14
|
-
export declare const RESOURCE_LIST_OPTIONS: string[];
|
|
15
|
-
/** The help for each ChRIS command, by name. */
|
|
16
|
-
/** The built-in names the ChRIS session answers, for `help variables`. */
|
|
17
|
-
export declare const CHRIS_BUILTIN_LINES: ReadonlyArray<string>;
|
|
18
|
-
export declare const chrisHelp: Record<string, CommandHelp>;
|
package/dist/chris/help.js
DELETED
|
@@ -1,229 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Standard subcommands and options injected into every resource help entry.
|
|
3
|
-
* Captures the Resource Contract documented in CONTEXT.md.
|
|
4
|
-
*/
|
|
5
|
-
export const RESOURCE_LIST_OPTIONS = [
|
|
6
|
-
'',
|
|
7
|
-
'STANDARD SUBCOMMANDS:',
|
|
8
|
-
' list List resources (default: 20 per page)',
|
|
9
|
-
' search <term> Search resources (alias: list --search <term>)',
|
|
10
|
-
' inspect List available field names',
|
|
11
|
-
'',
|
|
12
|
-
'STANDARD OPTIONS:',
|
|
13
|
-
' --all Fetch all pages',
|
|
14
|
-
' --limit <n> Page size (default: 20)',
|
|
15
|
-
' --fields <f,f> Columns to display',
|
|
16
|
-
' --sort <field> Sort by field',
|
|
17
|
-
' --reverse Reverse sort order',
|
|
18
|
-
' --table Tabular output',
|
|
19
|
-
' --csv CSV output',
|
|
20
|
-
];
|
|
21
|
-
/** The help for each ChRIS command, by name. */
|
|
22
|
-
/** The built-in names the ChRIS session answers, for `help variables`. */
|
|
23
|
-
export const CHRIS_BUILTIN_LINES = [
|
|
24
|
-
' ${gather} every gathered member, as operands (where it was gathered FROM); read live',
|
|
25
|
-
' ${gather.series.folderPath} the same members, where they LANDED in CUBE',
|
|
26
|
-
' ${gather.name} ${gather.feed.id} any field of the cohort, as `gather` answers it',
|
|
27
|
-
];
|
|
28
|
-
export const chrisHelp = {
|
|
29
|
-
plugin: {
|
|
30
|
-
category: 'Resources',
|
|
31
|
-
usage: 'plugin <subcommand> [options]',
|
|
32
|
-
description: 'Work with a single ChRIS plugin - search, view documentation',
|
|
33
|
-
options: [
|
|
34
|
-
'',
|
|
35
|
-
'DESCRIPTION:',
|
|
36
|
-
' Plugins are computational units in ChRIS that process data. The "plugin"',
|
|
37
|
-
' command operates on individual plugins - searching for specific plugins, or',
|
|
38
|
-
' viewing their documentation. A plugin RUNS by its name, as a line of its own,',
|
|
39
|
-
' where the session stands: pl-dcm2niix-v1.0.2 … (A=$(…) names the run).',
|
|
40
|
-
'',
|
|
41
|
-
'SUBCOMMANDS:',
|
|
42
|
-
' info <name>-v<version> Show one plugin whole: facts and every parameter',
|
|
43
|
-
' search <searchable> Resolve a searchable to plugin IDs',
|
|
44
|
-
' readme <pluginId> Display plugin README documentation',
|
|
45
|
-
' add <name|image|url> Register a plugin: by name or image (peer store, then the image), or a plugin URL in another CUBE',
|
|
46
|
-
' add --json <file> Register one descriptor file (a host path; cube:<path> for one in CUBE)',
|
|
47
|
-
' sync [source] Fill this CUBE from a plugin index: show the plan, ask, register what is missing',
|
|
48
|
-
' validate <file|dir|source> Check descriptors without a CUBE (a host path; owner/repo[@ref] or cube:<path>)',
|
|
49
|
-
' index [<owner/repo[@ref]>] Show or set the index sync reads; --reset restores FNNDSC/chris-plugins@main',
|
|
50
|
-
'',
|
|
51
|
-
'PLUGIN SYNC:',
|
|
52
|
-
' A source is owner/repo[@ref] (GitHub), a CUBE path (a directory of .json, or a .tar.gz), or host:<path>.',
|
|
53
|
-
' --ref <tag|commit> pin the index --plan show the plan and stop --yes apply without asking',
|
|
54
|
-
' --compute a,b register on these compute resources (default: all of them)',
|
|
55
|
-
' Sync never deletes and never changes a plugin already there; drift and newer-in-CUBE are reported.',
|
|
56
|
-
' Anyone may see the plan; applying it needs an administrator (sudo plugin sync).',
|
|
57
|
-
'',
|
|
58
|
-
'PLUGIN VALIDATE:',
|
|
59
|
-
' Rules: 1 schema · 2 CUBE upload rules · 3 file name = name · 4 no case clash · 5 images resolve',
|
|
60
|
-
' --offline skip rule 5 (the registry lookups); the report says it was not checked',
|
|
61
|
-
'',
|
|
62
|
-
'SEARCHABLE FORMATS:',
|
|
63
|
-
' Simple: pl-dircopy',
|
|
64
|
-
' Compound: name:pl-dircopy,version:1.3.2',
|
|
65
|
-
' ID-based: id:42',
|
|
66
|
-
' Batch: id:77++id:33 (multiple plugins)',
|
|
67
|
-
'',
|
|
68
|
-
'RUNNING A PLUGIN:',
|
|
69
|
-
' pl-dcm2niix-v1.0.2 --param value -- feed_title="T" run where you stand',
|
|
70
|
-
' pl-dcm2niix … the bare name runs the highest version, and says which',
|
|
71
|
-
' pl-dcm2niix ~/uploads/subjects on that tree instead of where you stand',
|
|
72
|
-
' pl-dcm2niix ~/uploads/t1.nii as sub-01 --param v one subject, the file in it; operands first',
|
|
73
|
-
' A=$(pl-dcm2niix-v1.0.2 …) and name the run',
|
|
74
|
-
'',
|
|
75
|
-
' Run "parametersofplugin <name>" to see available parameters for a plugin.',
|
|
76
|
-
],
|
|
77
|
-
examples: [
|
|
78
|
-
'# Read one plugin: the same manual "cat /bin/<entry>" prints',
|
|
79
|
-
'plugin info pl-dircopy-v1.0.0',
|
|
80
|
-
'plugin info pl-dircopy 1.0.0',
|
|
81
|
-
'',
|
|
82
|
-
'# Search for plugins',
|
|
83
|
-
'plugin search pl-dircopy',
|
|
84
|
-
'plugin search name:dcm2niix',
|
|
85
|
-
'plugin search id:42',
|
|
86
|
-
'',
|
|
87
|
-
'# View plugin documentation',
|
|
88
|
-
'plugin readme 42',
|
|
89
|
-
'plugin readme pl-dircopy',
|
|
90
|
-
'',
|
|
91
|
-
'# Register plugins',
|
|
92
|
-
'sudo plugin add pl-dircopy',
|
|
93
|
-
'sudo plugin add --json ./pl-dircopy.json',
|
|
94
|
-
'plugin sync --plan',
|
|
95
|
-
'sudo plugin sync FNNDSC/chris-plugins --ref 8c9a1f6',
|
|
96
|
-
'plugin validate ./plugins --offline',
|
|
97
|
-
'',
|
|
98
|
-
'# Run a plugin where you stand, and name the run',
|
|
99
|
-
'A=$(pl-dcm2niix-v1.0.2)',
|
|
100
|
-
'cd ${A.outputPath}',
|
|
101
|
-
],
|
|
102
|
-
},
|
|
103
|
-
plugins: {
|
|
104
|
-
category: 'Resources',
|
|
105
|
-
usage: 'plugins <subcommand> [options]',
|
|
106
|
-
description: 'Manage collections of ChRIS plugins - list, add, delete, query',
|
|
107
|
-
options: [
|
|
108
|
-
'',
|
|
109
|
-
'DESCRIPTION:',
|
|
110
|
-
' Plugins are computational units in ChRIS. The "plugins" command operates on',
|
|
111
|
-
' collections of plugins - listing all available plugins, adding new plugins to',
|
|
112
|
-
' ChRIS, deleting plugins, or querying plugin metadata.',
|
|
113
|
-
...RESOURCE_LIST_OPTIONS,
|
|
114
|
-
'',
|
|
115
|
-
'RESOURCE-SPECIFIC SUBCOMMANDS:',
|
|
116
|
-
' add <input> [admin] Register a new plugin to ChRIS',
|
|
117
|
-
' delete <id> [admin] Remove a plugin from ChRIS',
|
|
118
|
-
' overview Show plugin system overview',
|
|
119
|
-
'',
|
|
120
|
-
'PLUGINS ADD OPTIONS:',
|
|
121
|
-
' --compute <resources> Comma-separated compute resources (default: host)',
|
|
122
|
-
' --store <url> Peer store URL (default: cube.chrisproject.org)',
|
|
123
|
-
' --adminUser <username> Administrator username (non-interactive compatibility)',
|
|
124
|
-
' --adminPassword <password> Administrator password (non-interactive compatibility)',
|
|
125
|
-
' --publicRepo <url> Public repository URL for the plugin',
|
|
126
|
-
'',
|
|
127
|
-
'PLUGIN INPUT FORMATS:',
|
|
128
|
-
' Plugin name: pl-dircopy',
|
|
129
|
-
' Docker image: fnndsc/pl-dircopy:2.1.1',
|
|
130
|
-
' Store URL: https://cube.chrisproject.org/api/v1/plugins/96/',
|
|
131
|
-
],
|
|
132
|
-
examples: [
|
|
133
|
-
'# List all plugins',
|
|
134
|
-
'plugins list',
|
|
135
|
-
'plugins list --all',
|
|
136
|
-
'plugins list --search name:dircopy',
|
|
137
|
-
'plugins list --fields name,version,dock_image',
|
|
138
|
-
'plugins search dircopy',
|
|
139
|
-
'',
|
|
140
|
-
'# Inspect available fields',
|
|
141
|
-
'plugins inspect',
|
|
142
|
-
'',
|
|
143
|
-
'# Delete a plugin',
|
|
144
|
-
'plugins delete 42',
|
|
145
|
-
'',
|
|
146
|
-
'# Show plugin system overview',
|
|
147
|
-
'plugins overview',
|
|
148
|
-
'',
|
|
149
|
-
'# Add plugin from peer store (searches cube.chrisproject.org)',
|
|
150
|
-
'plugins add pl-dircopy',
|
|
151
|
-
'plugins add pl-dircopy --compute host,gpu',
|
|
152
|
-
'',
|
|
153
|
-
'# Add a plugin with a temporary administrator identity',
|
|
154
|
-
'sudo plugins add pl-dircopy',
|
|
155
|
-
'',
|
|
156
|
-
'# Add plugin from Docker image',
|
|
157
|
-
'plugins add fnndsc/pl-dircopy:2.1.1',
|
|
158
|
-
'plugins add fnndsc/pl-dircopy:2.1.1 --compute host',
|
|
159
|
-
'',
|
|
160
|
-
'# Add plugin from custom peer store',
|
|
161
|
-
'plugins add pl-custom --store https://my-cube.org/api/v1/',
|
|
162
|
-
'',
|
|
163
|
-
'# Add plugin with specific repository',
|
|
164
|
-
'plugins add my-plugin:latest --publicRepo https://github.com/org/my-plugin',
|
|
165
|
-
],
|
|
166
|
-
},
|
|
167
|
-
pipeline: {
|
|
168
|
-
category: 'Resources',
|
|
169
|
-
usage: 'pipeline <subcommand> [args]',
|
|
170
|
-
description: 'Manage and execute ChRIS pipelines (registered DAG workflows)',
|
|
171
|
-
options: [
|
|
172
|
-
...RESOURCE_LIST_OPTIONS,
|
|
173
|
-
'',
|
|
174
|
-
'RESOURCE-SPECIFIC SUBCOMMANDS:',
|
|
175
|
-
' info <name|id> Show pipeline nodes, plugins, and topology',
|
|
176
|
-
' manifest <name|id|slug> Emit complete registered invocation YAML',
|
|
177
|
-
' run <name|id> Run a pipeline from the feed node you are in, and wait for it',
|
|
178
|
-
' source <name|id> Display the pipeline YAML source file',
|
|
179
|
-
' diagram <name|id> Draw the pipeline as a shallow tree',
|
|
180
|
-
' --withargs Include stored non-null plugin defaults inline',
|
|
181
|
-
' --signalflow Emit SignalFlow YAML instead of the shallow tree',
|
|
182
|
-
' delete <id> Remove a pipeline',
|
|
183
|
-
'',
|
|
184
|
-
'RUN OPTIONS:',
|
|
185
|
-
' --detach Return the instance ids at once, without waiting',
|
|
186
|
-
' --compute <resource> Override compute resource for all nodes',
|
|
187
|
-
' --previous <inst_id> Start from this instance (default: the feed node cwd is in)',
|
|
188
|
-
' --paramFile <cfs-file> Apply one sparse YAML invocation overlay',
|
|
189
|
-
' --<node>.<parameter> <value> Override one hosted plugin parameter',
|
|
190
|
-
' --<node>.<control> <value> Override one node execution control',
|
|
191
|
-
' Use --@<piping-id>.<field> when a node title is ambiguous or shell-unsafe',
|
|
192
|
-
'',
|
|
193
|
-
'PIPELINE EXECUTABLES:',
|
|
194
|
-
' Pipelines also appear in /bin (colored magenta) and can be invoked directly.',
|
|
195
|
-
' <PipelineName> Run the pipeline from the feed node you are in',
|
|
196
|
-
' <PipelineName> --nodes Show DAG structure (alias: --parameters)',
|
|
197
|
-
' <PipelineName> --source Show YAML source (alias: --readme)',
|
|
198
|
-
' <PipelineName> --manifest Emit complete registered invocation YAML',
|
|
199
|
-
' <PipelineName> --diagram Draw the shallow pipeline topology',
|
|
200
|
-
' <PipelineName> --signalflow Emit SignalFlow YAML directly',
|
|
201
|
-
' --withargs Include arguments with --diagram',
|
|
202
|
-
' cat /bin/<PipelineName> Show a fast cached executable summary',
|
|
203
|
-
],
|
|
204
|
-
examples: [
|
|
205
|
-
'pipeline list # List all pipelines',
|
|
206
|
-
'pipeline list PHI # Filter by name',
|
|
207
|
-
'pipeline info PHI_detection # Show nodes and topology',
|
|
208
|
-
'pipeline manifest PHI_detection # Registered invocation YAML',
|
|
209
|
-
'pipeline run PHI_detection # Run from the feed node you are in',
|
|
210
|
-
'pipeline run PHI_detection --compute gpu',
|
|
211
|
-
'pipeline run PHI_detection --segmentation.threshold 0.5',
|
|
212
|
-
'pipeline run PHI_detection --paramFile ~/params/run.yaml',
|
|
213
|
-
'pipeline source PHI_detection # Show YAML source',
|
|
214
|
-
'pipeline diagram PHI_detection # Draw the authored DAG',
|
|
215
|
-
'pipeline diagram --withargs PHI_detection',
|
|
216
|
-
'pipeline diagram --signalflow PHI_detection | signalflow -',
|
|
217
|
-
'',
|
|
218
|
-
'# Direct invocation from /bin',
|
|
219
|
-
'PHI_detection # Run with defaults',
|
|
220
|
-
'PHI_detection --nodes # Show node structure',
|
|
221
|
-
'PHI_detection --source # Show YAML source',
|
|
222
|
-
'PHI_detection --manifest # Registered invocation YAML',
|
|
223
|
-
'PHI_detection --diagram # Draw the authored DAG',
|
|
224
|
-
'PHI_detection --signalflow # Emit SignalFlow YAML',
|
|
225
|
-
'cat /bin/PHI_detection # Cached executable summary',
|
|
226
|
-
],
|
|
227
|
-
},
|
|
228
|
-
};
|
|
229
|
-
//# sourceMappingURL=help.js.map
|
package/dist/chris/help.js.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"help.js","sourceRoot":"","sources":["../../src/chris/help.ts"],"names":[],"mappings":"AAUA;;;GAGG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAa;IAC7C,EAAE;IACF,uBAAuB;IACvB,2DAA2D;IAC3D,oEAAoE;IACpE,gDAAgD;IAChD,EAAE;IACF,mBAAmB;IACnB,qCAAqC;IACrC,6CAA6C;IAC7C,wCAAwC;IACxC,mCAAmC;IACnC,wCAAwC;IACxC,oCAAoC;IACpC,gCAAgC;CACjC,CAAC;AAEF,gDAAgD;AAChD,0EAA0E;AAC1E,MAAM,CAAC,MAAM,mBAAmB,GAA0B;IACxD,+FAA+F;IAC/F,4EAA4E;IAC5E,sFAAsF;CACvF,CAAC;AAEF,MAAM,CAAC,MAAM,SAAS,GAAgC;IACpD,MAAM,EAAE;QACN,QAAQ,EAAE,WAAW;QACrB,KAAK,EAAE,+BAA+B;QACtC,WAAW,EAAE,8DAA8D;QAC3E,OAAO,EAAE;YACP,EAAE;YACF,cAAc;YACd,4EAA4E;YAC5E,+EAA+E;YAC/E,iFAAiF;YACjF,0EAA0E;YAC1E,EAAE;YACF,cAAc;YACd,iFAAiF;YACjF,mEAAmE;YACnE,oEAAoE;YACpE,kIAAkI;YAClI,wGAAwG;YACxG,iHAAiH;YACjH,gHAAgH;YAChH,6GAA6G;YAC7G,EAAE;YACF,cAAc;YACd,4GAA4G;YAC5G,oGAAoG;YACpG,kFAAkF;YAClF,sGAAsG;YACtG,mFAAmF;YACnF,EAAE;YACF,kBAAkB;YAClB,mGAAmG;YACnG,8FAA8F;YAC9F,EAAE;YACF,qBAAqB;YACrB,0BAA0B;YAC1B,6CAA6C;YAC7C,qBAAqB;YACrB,gDAAgD;YAChD,EAAE;YACF,mBAAmB;YACnB,4EAA4E;YAC5E,wFAAwF;YACxF,8FAA8F;YAC9F,kGAAkG;YAClG,sEAAsE;YACtE,EAAE;YACF,6EAA6E;SAC9E;QACD,QAAQ,EAAE;YACR,8DAA8D;YAC9D,+BAA+B;YAC/B,8BAA8B;YAC9B,EAAE;YACF,sBAAsB;YACtB,0BAA0B;YAC1B,6BAA6B;YAC7B,qBAAqB;YACrB,EAAE;YACF,6BAA6B;YAC7B,kBAAkB;YAClB,0BAA0B;YAC1B,EAAE;YACF,oBAAoB;YACpB,4BAA4B;YAC5B,0CAA0C;YAC1C,oBAAoB;YACpB,qDAAqD;YACrD,qCAAqC;YACrC,EAAE;YACF,kDAAkD;YAClD,yBAAyB;YACzB,oBAAoB;SACrB;KACF;IACD,OAAO,EAAE;QACP,QAAQ,EAAE,WAAW;QACrB,KAAK,EAAE,gCAAgC;QACvC,WAAW,EAAE,gEAAgE;QAC7E,OAAO,EAAE;YACP,EAAE;YACF,cAAc;YACd,+EAA+E;YAC/E,iFAAiF;YACjF,yDAAyD;YACzD,GAAG,qBAAqB;YACxB,EAAE;YACF,gCAAgC;YAChC,4DAA4D;YAC5D,wDAAwD;YACxD,iDAAiD;YACjD,EAAE;YACF,sBAAsB;YACtB,mFAAmF;YACnF,iFAAiF;YACjF,wFAAwF;YACxF,wFAAwF;YACxF,sEAAsE;YACtE,EAAE;YACF,uBAAuB;YACvB,gCAAgC;YAChC,6CAA6C;YAC7C,sEAAsE;SACvE;QACD,QAAQ,EAAE;YACR,oBAAoB;YACpB,cAAc;YACd,oBAAoB;YACpB,oCAAoC;YACpC,+CAA+C;YAC/C,wBAAwB;YACxB,EAAE;YACF,4BAA4B;YAC5B,iBAAiB;YACjB,EAAE;YACF,mBAAmB;YACnB,mBAAmB;YACnB,EAAE;YACF,+BAA+B;YAC/B,kBAAkB;YAClB,EAAE;YACF,+DAA+D;YAC/D,wBAAwB;YACxB,2CAA2C;YAC3C,EAAE;YACF,wDAAwD;YACxD,6BAA6B;YAC7B,EAAE;YACF,gCAAgC;YAChC,qCAAqC;YACrC,oDAAoD;YACpD,EAAE;YACF,qCAAqC;YACrC,2DAA2D;YAC3D,EAAE;YACF,uCAAuC;YACvC,4EAA4E;SAC7E;KACF;IACD,QAAQ,EAAE;QACR,QAAQ,EAAE,WAAW;QACrB,KAAK,EAAE,8BAA8B;QACrC,WAAW,EAAE,+DAA+D;QAC5E,OAAO,EAAE;YACP,GAAG,qBAAqB;YACxB,EAAE;YACF,gCAAgC;YAChC,oEAAoE;YACpE,qEAAqE;YACrE,uFAAuF;YACvF,+DAA+D;YAC/D,6DAA6D;YAC7D,wEAAwE;YACxE,0EAA0E;YAC1E,2CAA2C;YAC3C,EAAE;YACF,cAAc;YACd,0EAA0E;YAC1E,iEAAiE;YACjE,qFAAqF;YACrF,mEAAmE;YACnE,sEAAsE;YACtE,qEAAqE;YACrE,6EAA6E;YAC7E,EAAE;YACF,uBAAuB;YACvB,gFAAgF;YAChF,8EAA8E;YAC9E,wEAAwE;YACxE,kEAAkE;YAClE,wEAAwE;YACxE,kEAAkE;YAClE,6DAA6D;YAC7D,gEAAgE;YAChE,qEAAqE;SACtE;QACD,QAAQ,EAAE;YACR,6DAA6D;YAC7D,yDAAyD;YACzD,kEAAkE;YAClE,qEAAqE;YACrE,4EAA4E;YAC5E,0CAA0C;YAC1C,yDAAyD;YACzD,0DAA0D;YAC1D,2DAA2D;YAC3D,gEAAgE;YAChE,2CAA2C;YAC3C,4DAA4D;YAC5D,EAAE;YACF,+BAA+B;YAC/B,4DAA4D;YAC5D,8DAA8D;YAC9D,2DAA2D;YAC3D,qEAAqE;YACrE,gEAAgE;YAChE,+DAA+D;YAC/D,oEAAoE;SACrE;KACF;CACF,CAAC"}
|