Skip to content

Commit a89cf47

Browse files
committed
reorder options in cycode scan; improve help text of report command
1 parent 1bdbcf8 commit a89cf47

File tree

3 files changed

+26
-26
lines changed

3 files changed

+26
-26
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -282,7 +282,7 @@ The following are the options and commands available with the Cycode CLI applica
282282
| [configure](#using-the-configure-command) | Initial command to configure your CLI client authentication. |
283283
| [ignore](#ignoring-scan-results) | Ignores a specific value, path or rule ID. |
284284
| [scan](#running-a-scan) | Scan the content for Secrets/IaC/SCA/SAST violations. You`ll need to specify which scan type to perform: commit-history/path/repository/etc. |
285-
| [report](#report-command) | Generate report. You`ll need to specify which report type to perform. |
285+
| [report](#report-command) | Generate report. You`ll need to specify which report type to perform as SBOM. |
286286
| status | Show the CLI status and exit. |
287287

288288
# Scan Command

cycode/cli/apps/report/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,5 @@
44
from cycode.cli.apps.report.report_command import report_command
55

66
app = typer.Typer(name='report', no_args_is_help=True)
7-
app.callback(short_help='Generate report. You`ll need to specify which report type to perform.')(report_command)
7+
app.callback(short_help='Generate report. You`ll need to specify which report type to perform as SBOM.')(report_command)
88
app.add_typer(sbom.app)

cycode/cli/apps/scan/scan_command.py

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,6 @@ def scan_command(
2929
case_sensitive=False,
3030
),
3131
] = ScanTypeOption.SECRET,
32-
show_secret: Annotated[
33-
bool, typer.Option('--show-secret', help='Show Secrets in plain text.', rich_help_panel=_SECRET_RICH_HELP_PANEL)
34-
] = False,
3532
soft_fail: Annotated[
3633
bool, typer.Option('--soft-fail', help='Run the scan without failing; always return a non-error status code.')
3734
] = False,
@@ -56,27 +53,9 @@ def scan_command(
5653
'A link to the report will be displayed in the console output.',
5754
),
5855
] = False,
59-
export_type: Annotated[
60-
ExportTypeOption,
61-
typer.Option(
62-
'--export-type',
63-
case_sensitive=False,
64-
help='Specify the export type. '
65-
'HTML and SVG will export terminal output and rely on --output option. '
66-
'JSON always exports JSON.',
67-
rich_help_panel=_EXPORT_RICH_HELP_PANEL,
68-
),
69-
] = ExportTypeOption.JSON,
70-
export_file: Annotated[
71-
Optional[Path],
72-
typer.Option(
73-
'--export-file',
74-
help='Export file. Path to the file where the export will be saved. ',
75-
dir_okay=False,
76-
writable=True,
77-
rich_help_panel=_EXPORT_RICH_HELP_PANEL,
78-
),
79-
] = None,
56+
show_secret: Annotated[
57+
bool, typer.Option('--show-secret', help='Show Secrets in plain text.', rich_help_panel=_SECRET_RICH_HELP_PANEL)
58+
] = False,
8059
sca_scan: Annotated[
8160
list[ScaScanTypeOption],
8261
typer.Option(
@@ -109,6 +88,27 @@ def scan_command(
10988
rich_help_panel=_SCA_RICH_HELP_PANEL,
11089
),
11190
] = False,
91+
export_type: Annotated[
92+
ExportTypeOption,
93+
typer.Option(
94+
'--export-type',
95+
case_sensitive=False,
96+
help='Specify the export type. '
97+
'HTML and SVG will export terminal output and rely on --output option. '
98+
'JSON always exports JSON.',
99+
rich_help_panel=_EXPORT_RICH_HELP_PANEL,
100+
),
101+
] = ExportTypeOption.JSON,
102+
export_file: Annotated[
103+
Optional[Path],
104+
typer.Option(
105+
'--export-file',
106+
help='Export file. Path to the file where the export will be saved. ',
107+
dir_okay=False,
108+
writable=True,
109+
rich_help_panel=_EXPORT_RICH_HELP_PANEL,
110+
),
111+
] = None,
112112
) -> None:
113113
""":mag: [bold cyan]Scan code for vulnerabilities (Secrets, IaC, SCA, SAST).[/]
114114

0 commit comments

Comments
 (0)