Skip to content

Commit 9465e88

Browse files
Updated report examples and replaced the full example with an image in the README (#206)
Co-authored-by: Ilya Siamionau <[email protected]>
1 parent 0d6cbac commit 9465e88

File tree

2 files changed

+4
-39
lines changed

2 files changed

+4
-39
lines changed

README.md

Lines changed: 4 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -329,56 +329,21 @@ When using this option, the scan results from this scan will appear in the knowl
329329
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.
330330
331331
`cycode scan -t sca --report repository ~/home/git/codebase`
332+
`cycode scan -t secret --report repository ~/home/git/codebase`
333+
332334
333335
or:
334336
335337
`cycode scan --scan-type sca --report repository ~/home/git/codebase`
338+
`cycode scan --scan-type secret --report repository ~/home/git/codebase`
336339
337340
When using this option, the scan results from this scan will appear in the On-Demand Scans section of Cycode. To get to this page, click the link that appears after the printed results:
338341
339342
> :warning: **NOTE**<br/>
340343
> You must be an `owner` or an `admin` in Cycode to view this page.
341344
342-
```bash
343-
Scan Results: (scan_id: e04e06e5-6dd8-474f-b409-33bbee67270b)
344-
⛔ Found issue of type: Security vulnerability in package 'vyper' referenced in project '': Multiple evaluation of contract address in call in vyper (rule ID: d003b23a-a2eb-42f3-83c9-7a84505603e5) in file: ./requirements.txt ⛔
345-
346-
1 | PyYAML~=5.3.1
347-
2 | vyper==0.3.1
348-
3 | cleo==1.0.0a5
349-
350-
⛔ Found issue of type: Security vulnerability in package 'vyper' referenced in project '': Integer bounds error in Vyper (rule ID: d003b23a-a2eb-42f3-83c9-7a84505603e5) in file: ./requirements.txt ⛔
351-
352-
1 | PyYAML~=5.3.1
353-
2 | vyper==0.3.1
354-
3 | cleo==1.0.0a5
355-
356-
⛔ Found issue of type: Security vulnerability in package 'pyyaml' referenced in project '': Improper Input Validation in PyYAML (rule ID: d003b23a-a2eb-42f3-83c9-7a84505603e5) in file: ./requirements.txt ⛔
357-
358-
1 | PyYAML~=5.3.1
359-
2 | vyper==0.3.1
360-
3 | cleo==1.0.0a5
345+
![cli-report](https://raw.githubusercontent.com/cycodehq/cycode-cli/main/images/sca_report_url.png)
361346
362-
⛔ Found issue of type: Security vulnerability in package 'cleo' referenced in project '': cleo is vulnerable to Regular Expression Denial of Service (ReDoS) (rule ID: d003b23a-a2eb-42f3-83c9-7a84505603e5) in file: ./requirements.txt ⛔
363-
364-
2 | vyper==0.3.1
365-
3 | cleo==1.0.0a5
366-
4 |
367-
368-
⛔ Found issue of type: Security vulnerability in package 'vyper' referenced in project '': Incorrect Comparison in Vyper (rule ID: d003b23a-a2eb-42f3-83c9-7a84505603e5) in file: ./requirements.txt ⛔
369-
370-
1 | PyYAML~=5.3.1
371-
2 | vyper==0.3.1
372-
3 | cleo==1.0.0a5
373-
374-
⛔ Found issue of type: Security vulnerability in package 'vyper' referenced in project '': Buffer Overflow in vyper (rule ID: d003b23a-a2eb-42f3-83c9-7a84505603e5) in file: ./requirements.txt ⛔
375-
376-
1 | PyYAML~=5.3.1
377-
2 | vyper==0.3.1
378-
3 | cleo==1.0.0a5
379-
380-
Report URL: https://app.cycode.com/on-demand-scans/617ecc3d-9ff2-493e-8be8-2c1fecaf6939
381-
```
382347
383348
The report page will look something like below:
384349

images/sca_report_url.png

200 KB
Loading

0 commit comments

Comments
 (0)