Skip to content

Commit d83878f

Browse files
MarshalXMarshalX
committed
update some docs; fix commit range option name
1 parent e06d520 commit d83878f

File tree

4 files changed

+15
-15
lines changed

4 files changed

+15
-15
lines changed

‎.pre-commit-hooks.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
language: python
44
language_version: python3
55
entry: cycode
6-
args: [ '--no-progress-meter', 'scan', '--scan-type', 'secret', 'pre_commit' ]
6+
args: [ '--no-progress-meter', 'scan', '--scan-type', 'secret', 'pre-commit' ]
77
- id: cycode-sca
88
name: Cycode SCA pre-commit defender
99
language: python
1010
language_version: python3
1111
entry: cycode
12-
args: [ '--no-progress-meter', 'scan', '--scan-type', 'sca', 'pre_commit' ]
12+
args: [ '--no-progress-meter', 'scan', '--scan-type', 'sca', 'pre-commit' ]

‎README.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -281,7 +281,7 @@ The following are the options and commands available with the Cycode CLI applica
281281
| [auth](#using-the-auth-command) | Authenticate your machine to associate the CLI with your Cycode account. |
282282
| [configure](#using-the-configure-command) | Initial command to configure your CLI client authentication. |
283283
| [ignore](#ignoring-scan-results) | Ignores a specific value, path or rule ID. |
284-
| [scan](#running-a-scan) | Scan the content for Secrets/IaC/SCA/SAST violations. You`ll need to specify which scan type to perform: commit_history/path/repository/etc. |
284+
| [scan](#running-a-scan) | Scan the content for Secrets/IaC/SCA/SAST violations. You`ll need to specify which scan type to perform: commit-history/path/repository/etc. |
285285
| [report](#report-command) | Generate report. You`ll need to specify which report type to perform. |
286286
| status | Show the CLI status and exit. |
287287

@@ -294,7 +294,7 @@ The Cycode CLI application offers several types of scans so that you can choose
294294
| Option | Description |
295295
|------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
296296
| `-t, --scan-type [secret\|iac\|sca\|sast]` | Specify the scan you wish to execute (`secret`/`iac`/`sca`/`sast`), the default is `secret`. |
297-
| `--secret TEXT` | Specify a Cycode client secret for this specific scan execution. |
297+
| `--client-secret TEXT` | Specify a Cycode client secret for this specific scan execution. |
298298
| `--client-id TEXT` | Specify a Cycode client ID for this specific scan execution. |
299299
| `--show-secret BOOLEAN` | Show secrets in plain text. See [Show/Hide Secrets](#showhide-secrets) section for more details. |
300300
| `--soft-fail BOOLEAN` | Run scan without failing, always return a non-error status code. See [Soft Fail](#soft-fail) section for more details. |
@@ -308,9 +308,9 @@ The Cycode CLI application offers several types of scans so that you can choose
308308

309309
| Command | Description |
310310
|----------------------------------------|-----------------------------------------------------------------|
311-
| [commit_history](#commit-history-scan) | Scan all the commits history in this git repository |
311+
| [commit-history](#commit-history-scan) | Scan all the commits history in this git repository |
312312
| [path](#path-scan) | Scan the files in the path supplied in the command |
313-
| [pre_commit](#pre-commit-scan) | Use this command to scan the content that was not committed yet |
313+
| [pre-commit](#pre-commit-scan) | Use this command to scan the content that was not committed yet |
314314
| [repository](#repository-scan) | Scan git repository including its history |
315315

316316
### Options
@@ -466,25 +466,25 @@ A commit history scan is limited to a local repository’s previous commits, foc
466466
467467
To execute a commit history scan, execute the following:
468468
469-
`cycode scan commit_history {{path}}`
469+
`cycode scan commit-history {{path}}`
470470
471471
For example, consider a scenario in which you want to scan the commit history for a repository stored in `~/home/git/codebase`. You could then execute the following:
472472
473-
`cycode scan commit_history ~/home/git/codebase`
473+
`cycode scan commit-history ~/home/git/codebase`
474474
475475
The following options are available for use with this command:
476476
477477
| Option | Description |
478478
|---------------------------|----------------------------------------------------------------------------------------------------------|
479-
| `-r, --commit_range TEXT` | Scan a commit range in this git repository, by default cycode scans all commit history (example: HEAD~1) |
479+
| `-r, --commit-range TEXT` | Scan a commit range in this git repository, by default cycode scans all commit history (example: HEAD~1) |
480480
481481
#### Commit Range Option
482482
483-
The commit history scan, by default, examines the repository’s entire commit history, all the way back to the initial commit. You can instead limit the scan to a specific commit range by adding the argument `--commit_range` (`-r`) followed by the name you specify.
483+
The commit history scan, by default, examines the repository’s entire commit history, all the way back to the initial commit. You can instead limit the scan to a specific commit range by adding the argument `--commit-range` (`-r`) followed by the name you specify.
484484
485485
Consider the previous example. If you wanted to scan only specific commits in your repository, you could execute the following:
486486
487-
`cycode scan commit_history -r {{from-commit-id}}...{{to-commit-id}} ~/home/git/codebase`
487+
`cycode scan commit-history -r {{from-commit-id}}...{{to-commit-id}} ~/home/git/codebase`
488488
489489
### Pre-Commit Scan
490490
@@ -823,7 +823,7 @@ The following commands are available for use with this command:
823823
| Command | Description |
824824
|------------------|-----------------------------------------------------------------|
825825
| `path` | Generate SBOM report for provided path in the command |
826-
| `repository_url` | Generate SBOM report for provided repository URI in the command |
826+
| `repository-url` | Generate SBOM report for provided repository URI in the command |
827827
828828
### Repository
829829

‎cycode/cli/apps/scan/commit_history/commit_history_command.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ def commit_history_command(
1717
commit_range: Annotated[
1818
str,
1919
typer.Option(
20-
'--commit_range',
20+
'--commit-range',
2121
'-r',
22-
help='Scan a commit range in this git repository (example: HEAD~1)',
22+
help='Scan a commit range in this Git repository (example: HEAD~1)',
2323
show_default='cycode scans all commit history',
2424
),
2525
] = '--all',

‎pyproject.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ style = "pep440"
7373

7474
[tool.ruff]
7575
line-length = 120
76-
target-version = "py38"
76+
target-version = "py39"
7777

7878
[tool.ruff.lint]
7979
extend-select = [

0 commit comments

Comments
 (0)