Skip to content

Commit 14b65b7

Browse files
committed
Update app process help for analysis-type flag
1 parent 4f70797 commit 14b65b7

1 file changed

Lines changed: 21 additions & 3 deletions

File tree

cli/src/commands/app/process.ts

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,19 +12,37 @@ import ProgressBar from "progress";
1212
import { AnalysisType, RequestConfig } from "@nowsecure/platform-lib";
1313

1414
export default class ProcessBinary extends BaseCommand {
15-
static description = "Upload and analyze an application binary";
15+
static summary = "Upload and analyze an application binary";
1616

1717
static examples = [`<%= config.bin %> <%= command.id %> my_application.apk`];
1818

1919
static flags = {
2020
...groupFlags,
2121
"set-version": Flags.string({
2222
char: "v",
23-
summary: "Set the version of the uploaded binary",
23+
summary: "Set the version of the uploaded binary.",
24+
description: `Attached a custom version string to the uploaded build,
25+
overriding the version string contained in the package file.
26+
27+
The custom string will be displayed in the "Version" column of the application list in Platform.`
2428
}),
2529
"analysis-type": Flags.string({
2630
char: "t",
27-
summary: "The type of analysis to perform",
31+
summary: "The type of analysis to perform.",
32+
description: `"static": Perform a static analysis only.
33+
"dependencies": Analyze the application's library dependencies.
34+
"full": Run a complete assessment including dynamic analysis.
35+
36+
If the flag is not specified a full analysis will be run.
37+
38+
Static-only and dependency-only analyses do not attempt to decrypt encrypted binaries as
39+
these analyses are intended to provide a rapid result for e.g. a CI/CD pipeline. An encrypted
40+
binary will fail to analyze.
41+
42+
Please note:
43+
The assessment status on NowSecure Platform UI does not reflect successful completion of
44+
static-only or dependencies-only analysis. The labels in the UI will be "Partial Results"
45+
and "Failed Dynamic Analysis" due to the lack of a dynamic analysis.`,
2846
options: Object.values(AnalysisType),
2947
}),
3048
};

0 commit comments

Comments
 (0)