Skip to content

Commit ae85c8f

Browse files
authored
CM-32756, CM-32757 - Update README (#214)
1 parent 9940c92 commit ae85c8f

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ This guide will guide you through both installation and usage.
3838
2. [IaC Result Example](#iac-result-example)
3939
3. [SCA Result Example](#sca-result-example)
4040
4. [SAST Result Example](#sast-result-example)
41+
4. [Company’s Custom Remediation Guidelines](#companys-custom-remediation-guidelines)
4142
3. [Ignoring Scan Results](#ignoring-scan-results)
4243
1. [Ignoring a Secret Value](#ignoring-a-secret-value)
4344
2. [Ignoring a Secret SHA Value](#ignoring-a-secret-sha-value)
@@ -68,9 +69,10 @@ To install the Cycode CLI application on your local machine, perform the followi
6869

6970
1. Open your command line or terminal application.
7071

71-
2. Execute the following command:
72+
2. Execute one of the following commands:
7273

73-
`pip3 install cycode`
74+
- `pip3 install cycode` - to install from PyPI
75+
- `brew install cycode` - to install from Homebrew
7476

7577
3. Navigate to the top directory of the local repository you wish to scan.
7678

@@ -324,14 +326,13 @@ When using this option, the scan results from this scan will appear in the knowl
324326
### Report Option
325327
326328
> [!NOTE]
327-
> This option is only available to SCA and Secret scans.
329+
> This option is not available to IaC scans.
328330
329331
To push scan results tied to the [SCA policies](https://docs.cycode.com/docs/sca-policies) found in the Repository scan to Cycode, add the argument `--report` to the scan command.
330332
331333
`cycode scan -t sca --report repository ~/home/git/codebase`
332334
`cycode scan -t secret --report repository ~/home/git/codebase`
333335
334-
335336
or:
336337
337338
`cycode scan --scan-type sca --report repository ~/home/git/codebase`
@@ -559,6 +560,10 @@ Secret SHA: a44081db3296c84b82d12a35c446a3cba19411dddfa0380134c75f7b3973bff0
559560
4 | print(res.content)
560561
```
561562
563+
### Company’s Custom Remediation Guidelines
564+
565+
If your company has set custom remediation guidelines in the relevant policy via the Cycode portal, you'll see a field for “Company Guidelines” that contains the remediation guidelines you added. Note that if you haven't added any company guideline, this field will not appear in the CLI tool.
566+
562567
## Ignoring Scan Results
563568
564569
Ignore rules can be added to ignore specific secret values, specific SHA512 values, specific paths, and specific Cycode secret and IaC rule IDs. This will cause the scan to not alert these values. The ignore rules are written and saved locally in the `./.cycode/config.yaml` file.

0 commit comments

Comments
 (0)