Skip to content

Commit

Permalink
Update app process help for analysis-type flag
Browse files Browse the repository at this point in the history
  • Loading branch information
cosdon committed May 30, 2023
1 parent 4f70797 commit 14b65b7
Showing 1 changed file with 21 additions and 3 deletions.
24 changes: 21 additions & 3 deletions cli/src/commands/app/process.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,37 @@ import ProgressBar from "progress";
import { AnalysisType, RequestConfig } from "@nowsecure/platform-lib";

export default class ProcessBinary extends BaseCommand {
static description = "Upload and analyze an application binary";
static summary = "Upload and analyze an application binary";

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

static flags = {
...groupFlags,
"set-version": Flags.string({
char: "v",
summary: "Set the version of the uploaded binary",
summary: "Set the version of the uploaded binary.",
description: `Attached a custom version string to the uploaded build,
overriding the version string contained in the package file.
The custom string will be displayed in the "Version" column of the application list in Platform.`
}),
"analysis-type": Flags.string({
char: "t",
summary: "The type of analysis to perform",
summary: "The type of analysis to perform.",
description: `"static": Perform a static analysis only.
"dependencies": Analyze the application's library dependencies.
"full": Run a complete assessment including dynamic analysis.

This comment has been minimized.

Copy link
@lei628

lei628 May 31, 2023

Perform a baseline assessment including both static and dynamic analysis

If the flag is not specified a full analysis will be run.
Static-only and dependency-only analyses do not attempt to decrypt encrypted binaries as
these analyses are intended to provide a rapid result for e.g. a CI/CD pipeline. An encrypted
binary will fail to analyze.
Please note:
The assessment status on NowSecure Platform UI does not reflect successful completion of
static-only or dependencies-only analysis. The labels in the UI will be "Partial Results"
and "Failed Dynamic Analysis" due to the lack of a dynamic analysis.`,
options: Object.values(AnalysisType),
}),
};
Expand Down

0 comments on commit 14b65b7

Please sign in to comment.