Skip to content

Commit 32a74aa

Browse files
committed
fix indents, etc
1 parent 6c58f71 commit 32a74aa

File tree

1 file changed

+18
-8
lines changed

1 file changed

+18
-8
lines changed

README.md

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -112,8 +112,8 @@ To install the Cycode CLI application on your local machine, perform the followi
112112
113113
<img alt="authorize CLI" height="450" src="https://raw.githubusercontent.com/cycodehq/cycode-cli/main/images/authorize_cli.png"/>
114114
115-
> [!NOTE]
116-
> This will be the default method for authenticating with the Cycode CLI.
115+
> [!NOTE]
116+
> This will be the default method for authenticating with the Cycode CLI.
117117
118118
5. Click the **Allow** button to authorize the Cycode CLI on the selected business group.
119119
@@ -125,7 +125,7 @@ To install the Cycode CLI application on your local machine, perform the followi
125125

126126
7. In the terminal/command line screen, you will see the following when exiting the browser window:
127127

128-
`Successfully logged into cycode`
128+
`Successfully logged into cycode`
129129

130130
### Using the Configure Command
131131

@@ -348,7 +348,8 @@ When using this option, the scan results from this scan will appear in the knowl
348348
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.
349349
350350
`cycode scan -t sca --report repository ~/home/git/codebase`
351-
`cycode scan -t secret --report repository ~/home/git/codebase`
351+
352+
In the same way, you can push scan results of Secrets and SAST scans to Cycode by adding the `--report` option to the scan command.
352353
353354
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:
354355
@@ -385,12 +386,18 @@ Consider the previous example. If you wanted to only scan a branch named `dev`,
385386
386387
#### Lock Restore Option
387388
389+
> [!NOTE]
390+
> This option is only available to SCA scans.
391+
388392
We use sbt-dependency-lock plugin to restore the lock file for SBT projects.
389393
To disable lock restore in use `--no-restore` option.
390394
391-
Prerequisites
392-
* sbt-dependency-lock Plugin: Install the plugin by adding the following line to `project/plugins.sbt`:
393-
`addSbtPlugin("software.purpledragon" % "sbt-dependency-lock" % "1.5.1")`
395+
Prerequisites:
396+
* `sbt-dependency-lock` plugin: Install the plugin by adding the following line to `project/plugins.sbt`:
397+
398+
```text
399+
addSbtPlugin("software.purpledragon" % "sbt-dependency-lock" % "1.5.1")
400+
```
394401
395402
### Repository Scan
396403
@@ -486,7 +493,9 @@ A pre-commit scan automatically identifies any issues before you commit changes
486493
487494
After installing the pre-commit hook, you may occasionally wish to skip scanning during a specific commit. To do this, add the following to your `git` command to skip scanning for a single commit:
488495
489-
`SKIP=cycode git commit -m <your commit message>`
496+
```bash
497+
SKIP=cycode git commit -m <your commit message>`
498+
```
490499
491500
## Scan Results
492501
@@ -764,6 +773,7 @@ exclusions:
764773
```
765774
766775
Possible values of `scanTypeName`: `iac`, `sca`, `sast`, `secret`.
776+
767777
Possible values of `ignoringType`: `paths`, `values`, `rules`, `packages`, `shas`, `cves`.
768778
769779
> [!WARNING]

0 commit comments

Comments
 (0)