Skip to content

CM-25595 - Drop support of --version option #147

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 24, 2023
Merged

CM-25595 - Drop support of --version option #147

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b55eec3
CM-25595 - Drop support of --version option
MarshalX Jul 23, 2023
c10ffbf
fix markdown
MarshalX Jul 23, 2023
384ebe7
Merge branch 'main' into CM-25595-drop-legacy-support-of-version-option
MarshalX Jul 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/build_executable.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ jobs:
run: poetry run pyinstaller pyinstaller.spec

- name: Test executable
run: ./dist/cycode --version
run: ./dist/cycode version

- name: Sign macOS executable
if: ${{ startsWith(matrix.os, 'macos') }}
Expand Down Expand Up @@ -110,7 +110,7 @@ jobs:

- name: Test signed executable
if: ${{ startsWith(matrix.os, 'macos') }}
run: ./dist/cycode --version
run: ./dist/cycode version

- uses: actions/upload-artifact@v3
with:
Expand Down
27 changes: 14 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,19 +213,19 @@ repos:

The following are the options and commands available with the Cycode CLI application:

| Option | Description |
|--------------------------------------|-------------------------------------------------------------------|
| `-o`, `--output [text\|json\|table]` | Specify the output (`text`/`json`/`table`). The default is `text` |
| `-v`, `--verbose` | Show detailed logs |
| `--version` | Show the version and exit. |
| `--help` | Show options for given command. |

| Command | Description |
|-------------------------------------|-------------|
| [auth](#use-auth-command) | Authenticates your machine to associate CLI with your Cycode account. |
| [configure](#use-configure-command) | Initial command to authenticate your CLI client with Cycode using client ID and client secret. |
| [ignore](#ingoring-scan-results) | Ignore a specific value, path or rule ID |
| [scan](#running-a-scan) | Scan content for secrets/IaC/SCA/SAST violations. You need to specify which scan type: `ci`/`commit_history`/`path`/`repository`/etc |
| Option | Description |
|--------------------------------------|--------------------------------------------------------------------|
| `-o`, `--output [text\|json\|table]` | Specify the output (`text`/`json`/`table`). The default is `text`. |
| `-v`, `--verbose` | Show detailed logs. |
| `--help` | Show options for given command. |

| Command | Description |
|-------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------|
| [auth](#use-auth-command) | Authenticates your machine to associate CLI with your Cycode account. |
| [configure](#use-configure-command) | Initial command to authenticate your CLI client with Cycode using client ID and client secret. |
| [ignore](#ingoring-scan-results) | Ignore a specific value, path or rule ID. |
| [scan](#running-a-scan) | Scan content for secrets/IaC/SCA/SAST violations. You need to specify which scan type: `ci`/`commit_history`/`path`/`repository`/etc. |
| version | Show the version and exit. |

# Running a Scan

Expand Down Expand Up @@ -555,6 +555,7 @@ Ignore rules can be added to ignore specific secret values, specific SHA512 valu

> :warning: **Warning**<br/>
> Adding values to be ignored should be done with careful consideration of the values, paths, and policies to ensure that the scans will pick up true positives.

The following are the options available for the `cycode ignore` command:

| Option | Description |
Expand Down
1 change: 0 additions & 1 deletion cycode/cli/main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,6 @@ def version(context: click.Context) -> None:
help='Characteristic JSON object that lets servers identify the application',
type=str,
)
@click.version_option(__version__, prog_name=PROGRAM_NAME)
@click.pass_context
def main_cli(
context: click.Context, verbose: bool, no_progress_meter: bool, output: str, user_agent: Optional[str]
Expand Down