Skip to content

Commit 8ac74b3

Browse files
juliebyrne-ghjuliebyrne-gh
authored
Remove outdated RIG references with --monitor flag in README (#315)
1 parent 9a90843 commit 8ac74b3

File tree

1 file changed

+22
-19
lines changed

1 file changed

+22
-19
lines changed

‎README.md

Lines changed: 22 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,8 @@ This guide walks you through both installation and usage.
5050
6. [Ignoring via a config file](#ignoring-via-a-config-file)
5151
5. [Report command](#report-command)
5252
1. [Generating SBOM Report](#generating-sbom-report)
53-
6. [Syntax Help](#syntax-help)
53+
6. [Scan logs](#scan-logs)
54+
7. [Syntax Help](#syntax-help)
5455

5556
# Prerequisites
5657

@@ -291,20 +292,20 @@ The following are the options and commands available with the Cycode CLI applica
291292

292293
The Cycode CLI application offers several types of scans so that you can choose the option that best fits your case. The following are the current options and commands available:
293294

294-
| Option | Description |
295-
|------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
296-
| `-t, --scan-type [secret\|iac\|sca\|sast]` | Specify the scan you wish to execute (`secret`/`iac`/`sca`/`sast`), the default is `secret`. |
297-
| `--client-secret TEXT` | Specify a Cycode client secret for this specific scan execution. |
298-
| `--client-id TEXT` | Specify a Cycode client ID for this specific scan execution. |
299-
| `--show-secret BOOLEAN` | Show secrets in plain text. See [Show/Hide Secrets](#showhide-secrets) section for more details. |
300-
| `--soft-fail BOOLEAN` | Run scan without failing, always return a non-error status code. See [Soft Fail](#soft-fail) section for more details. |
301-
| `--severity-threshold [INFO\|LOW\|MEDIUM\|HIGH\|CRITICAL]` | Show only violations at the specified level or higher. |
302-
| `--sca-scan` | Specify the SCA scan you wish to execute (`package-vulnerabilities`/`license-compliance`). The default is both. |
303-
| `--monitor` | When specified, the scan results will be recorded in the knowledge graph. Please note that when working in `monitor` mode, the knowledge graph will not be updated as a result of SCM events (Push, Repo creation). (Supported for SCA scan type only). |
304-
| `--cycode-report` | When specified, displays a link to the scan report in the Cycode platform in the console output. |
305-
| `--no-restore` | When specified, Cycode will not run restore command. Will scan direct dependencies ONLY! |
306-
| `--gradle-all-sub-projects` | When specified, Cycode will run gradle restore command for all sub projects. Should run from root project directory ONLY! |
307-
| `--help` | Show options for given command. |
295+
| Option | Description |
296+
|------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------|
297+
| `-t, --scan-type [secret\|iac\|sca\|sast]` | Specify the scan you wish to execute (`secret`/`iac`/`sca`/`sast`), the default is `secret`. |
298+
| `--client-secret TEXT` | Specify a Cycode client secret for this specific scan execution. |
299+
| `--client-id TEXT` | Specify a Cycode client ID for this specific scan execution. |
300+
| `--show-secret BOOLEAN` | Show secrets in plain text. See [Show/Hide Secrets](#showhide-secrets) section for more details. |
301+
| `--soft-fail BOOLEAN` | Run scan without failing, always return a non-error status code. See [Soft Fail](#soft-fail) section for more details. |
302+
| `--severity-threshold [INFO\|LOW\|MEDIUM\|HIGH\|CRITICAL]` | Show only violations at the specified level or higher. |
303+
| `--sca-scan` | Specify the SCA scan you wish to execute (`package-vulnerabilities`/`license-compliance`). The default is both. |
304+
| `--monitor` | When specified, the scan results will be recorded in Cycode. |
305+
| `--cycode-report` | When specified, displays a link to the scan report in the Cycode platform in the console output. |
306+
| `--no-restore` | When specified, Cycode will not run restore command. Will scan direct dependencies ONLY! |
307+
| `--gradle-all-sub-projects` | When specified, Cycode will run gradle restore command for all sub projects. Should run from root project directory ONLY! |
308+
| `--help` | Show options for given command. |
308309

309310
| Command | Description |
310311
|----------------------------------------|-----------------------------------------------------------------|
@@ -328,16 +329,14 @@ The following command will scan the repository for policy violations that have s
328329
> [!NOTE]
329330
> This option is only available to SCA scans.
330331

331-
To push scan results tied to the [SCA policies](https://docs.cycode.com/docs/sca-policies) found in an SCA type scan to Cycode's knowledge graph, add the argument `--monitor` to the scan command.
332+
To push scan results tied to the [SCA policies](https://docs.cycode.com/docs/sca-policies) found in an SCA type scan to Cycode, add the argument `--monitor` to the scan command.
332333

333334
Consider the following example. The following command will scan the repository for SCA policy violations and push them to Cycode:
334335

335336
`cycode scan -t sca --monitor repository ~/home/git/codebase`
336337

337-
When using this option, the scan results from this scan will appear in the knowledge graph, which can be found [here](https://app.cycode.com/query-builder).
338+
When using this option, the scan results will appear in Cycode.
338339

339-
> [!WARNING]
340-
> You must be an `owner` or an `admin` in Cycode to view the knowledge graph page.
341340

342341
#### Cycode Report Option
343342

@@ -838,6 +837,10 @@ To create an SBOM report for a path:\
838837
For example:\
839838
`cycode report sbom --format spdx-2.3 --include-vulnerabilities --include-dev-dependencies path /path/to/local/project`
840839
840+
# Scan Logs
841+
842+
All CLI scan are logged in Cycode. The logs can be found under Settings > CLI Logs.
843+
841844
# Syntax Help
842845
843846
You may add the `--help` argument to any command at any time to see a help message that will display available options and their syntax.

0 commit comments

Comments
 (0)