Skip to content

Commit 73a096b

Browse files
gotbadgerelsapet
andauthored
CM-49357 - Add suggestions on copy
Co-authored-by: elsapet <[email protected]>
1 parent 2799fe1 commit 73a096b

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ To install the Cycode CLI application on your local machine, perform the followi
9494
./cycode
9595
```
9696

97-
3. Finally authenticate the CLI, there are three methods to set the Cycode client ID and client secret:
97+
3. Finally authenticate the CLI. There are three methods to set the Cycode client ID and client secret:
9898

9999
- [cycode auth](#using-the-auth-command) (**Recommended**)
100100
- [cycode configure](#using-the-configure-command)
@@ -330,7 +330,7 @@ The Cycode CLI application offers several types of scans so that you can choose
330330

331331
To limit the results of the scan to a specific severity threshold, the argument `--severity-threshold` can be added to the scan command.
332332

333-
For example the following command will scan the repository for policy violations that have severity of Medium or higher:
333+
For example, the following command will scan the repository for policy violations that have severity of Medium or higher:
334334

335335
`cycode scan --severity-threshold MEDIUM repository ~/home/git/codebase`
336336

@@ -341,7 +341,7 @@ For example the following command will scan the repository for policy violations
341341

342342
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.
343343

344-
For example the following command will scan the repository for SCA policy violations and push them to Cycode platform:
344+
For example, the following command will scan the repository for SCA policy violations and push them to Cycode platform:
345345

346346
`cycode scan -t sca --monitor repository ~/home/git/codebase`
347347

@@ -409,7 +409,7 @@ To execute a full repository scan, execute the following:
409409

410410
`cycode scan repository {{path}}`
411411

412-
For example, in a scenario in which you want to scan your repository stored in `~/home/git/codebase`. You could then execute the following:
412+
For example, if you wanted to scan a repository stored in `~/home/git/codebase`, you could execute the following:
413413

414414
`cycode scan repository ~/home/git/codebase`
415415

@@ -445,7 +445,7 @@ Cycode CLI supports Terraform plan scanning (supporting Terraform 0.12 and later
445445

446446
Terraform plan file must be in JSON format (having `.json` extension)
447447

448-
If you just have a configuration file you can generate a plan by doing the following:
448+
If you just have a configuration file, you can generate a plan by doing the following:
449449

450450
1. Initialize a working directory that contains Terraform configuration file:
451451

@@ -525,9 +525,9 @@ The result would then not be obfuscated.
525525
526526
### Soft Fail
527527
528-
In normal operation the CLI will return an exit code of `1` when issues are found in the scan results. Depending on your CI/CD setup this will usually result in an overall failure. However, if you dont want this to happen you can use the soft fail feature.
528+
In normal operation the CLI will return an exit code of `1` when issues are found in the scan results. Depending on your CI/CD setup this will usually result in an overall failure. If you don't want this to happen, you can use the soft fail feature.
529529
530-
By adding the `--soft-fail` option to any type of scan, the exit code will be forced to `0` regardless of if any results are found or not.
530+
By adding the `--soft-fail` option to any type of scan, the exit code will be forced to `0` regardless of whether any results are found.
531531
532532
### Example Scan Results
533533

0 commit comments

Comments
 (0)