Skip to content

Commit f68bb9c

Browse files
Update README.md
I tried to remove the references to the RIG with the --monitor flag as this information is outdated.
1 parent 9a90843 commit f68bb9c

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

README.md

Lines changed: 9 additions & 6 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

@@ -300,7 +301,7 @@ The Cycode CLI application offers several types of scans so that you can choose
300301
| `--soft-fail BOOLEAN` | Run scan without failing, always return a non-error status code. See [Soft Fail](#soft-fail) section for more details. |
301302
| `--severity-threshold [INFO\|LOW\|MEDIUM\|HIGH\|CRITICAL]` | Show only violations at the specified level or higher. |
302303
| `--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+
| `--monitor` | When specified, the scan results will be recorded in Cycode. 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). |
304305
| `--cycode-report` | When specified, displays a link to the scan report in the Cycode platform in the console output. |
305306
| `--no-restore` | When specified, Cycode will not run restore command. Will scan direct dependencies ONLY! |
306307
| `--gradle-all-sub-projects` | When specified, Cycode will run gradle restore command for all sub projects. Should run from root project directory ONLY! |
@@ -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)