# Cycode CLI User Guide
The Cycode Command Line Interface (CLI) is an application you can install on your local machine which can scan your locally stored repositories for any secrets or infrastructure as code misconfigurations.
This guide will guide you through both installation and usage.
# Table of Contents
1. [Prerequisites](#prerequisites)
2. [Installation](#installation)
1. [Install Cycode CLI](#install-cycode-cli)
1. [Using the Auth Command](#using-the-auth-command)
2. [Using the Configure Command](#using-the-configure-command)
3. [Add to Environment Variables](#add-to-environment-variables)
1. [On Unix/Linux](#on-unixlinux)
2. [On Windows](#on-windows)
2. [Install Pre-Commit Hook](#install-pre-commit-hook)
3. [Cycode Command](#cycode-cli-commands)
4. [Scan Command](#scan-command)
1. [Running a Scan](#running-a-scan)
1. [Repository Scan](#repository-scan)
1. [Branch Option](#branch-option)
2. [Monitor Option](#monitor-option)
3. [Report Option](#report-option)
4. [Package Vulnerabilities Scan](#package-vulnerabilities-option)
1. [License Compliance Option](#license-compliance-option)
2. [Severity Threshold](#severity-threshold)
5. [Path Scan](#path-scan)
1. [Terraform Plan Scan](#terraform-plan-scan)
6. [Commit History Scan](#commit-history-scan)
1. [Commit Range Option](#commit-range-option)
7. [Pre-Commit Scan](#pre-commit-scan)
2. [Scan Results](#scan-results)
1. [Show/Hide Secrets](#showhide-secrets)
2. [Soft Fail](#soft-fail)
3. [Example Scan Results](#example-scan-results)
1. [Secrets Result Example](#secrets-result-example)
2. [IaC Result Example](#iac-result-example)
3. [SCA Result Example](#sca-result-example)
4. [SAST Result Example](#sast-result-example)
4. [Company’s Custom Remediation Guidelines](#companys-custom-remediation-guidelines)
3. [Ignoring Scan Results](#ignoring-scan-results)
1. [Ignoring a Secret Value](#ignoring-a-secret-value)
2. [Ignoring a Secret SHA Value](#ignoring-a-secret-sha-value)
3. [Ignoring a Path](#ignoring-a-path)
4. [Ignoring a Secret, IaC, or SCA Rule](#ignoring-a-secret-iac-sca-or-sast-rule)
5. [Ignoring a Package](#ignoring-a-package)
6. [Ignoring using config file](#ignoring-using-config-file)
5. [Report command](#report-command)
1. [Generating SBOM Report](#generating-sbom-report)
6. [Syntax Help](#syntax-help)
# Prerequisites
> [!WARNING]
> Python 3.7 end-of-life was on 2023-06-27.
> It is recommended to use Python 3.8 or later.
> We will drop support for Python 3.7 soon.
- The Cycode CLI application requires Python version 3.7 or later.
- Use the [`cycode auth` command](#using-the-auth-command) to authenticate to Cycode with the CLI
- Alternatively, you can obtain a Cycode Client ID and Client Secret Key by following the steps detailed in the [Service Account Token](https://docs.cycode.com/reference/creating-a-service-account-access-token) and [Personal Access Token](https://docs.cycode.com/reference/creating-a-personal-access-token-1) pages, which contain details on obtaining these values.
# Installation
The following installation steps are applicable to both Windows and UNIX / Linux operating systems.
> [!NOTE]
> The following steps assume the use of `python3` and `pip3` for Python-related commands; however, some systems may instead use the `python` and `pip` commands, depending on your Python environment’s configuration.
## Install Cycode CLI
To install the Cycode CLI application on your local machine, perform the following steps:
1. Open your command line or terminal application.
2. Execute one of the following commands:
- `pip3 install cycode` - to install from PyPI
- `brew install cycode` - to install from Homebrew
3. Navigate to the top directory of the local repository you wish to scan.
4. There are three methods to set the Cycode client ID and client secret:
- [cycode auth](#using-the-auth-command) (**Recommended**)
- [cycode configure](#using-the-configure-command)
- Add them to your [environment variables](#add-to-environment-variables)
### Using the Auth Command
> [!NOTE]
> This is the **recommended** method for setting up your local machine to authenticate with Cycode CLI.
1. Type the following command into your terminal/command line window:
`cycode auth`
2. A browser window will appear, asking you to log into Cycode (as seen below):
3. Enter your login credentials on this page and log in.
4. You will eventually be taken to the page below, where you'll be asked to choose the business group you want to authorize Cycode with (if applicable):
> [!NOTE]
> This will be the default method for authenticating with the Cycode CLI.
5. Click the **Allow** button to authorize the Cycode CLI on the selected business group.
6. Once completed, you'll see the following screen, if it was selected successfully:
7. In the terminal/command line screen, you will see the following when exiting the browser window:
```bash
Successfully logged into cycode
```
### Using the Configure Command
> [!NOTE]
> If you already set up your Cycode Client ID and Client Secret through the Linux or Windows environment variables, those credentials will take precedent over this method.
1. Type the following command into your terminal/command line window:
`cycode configure`
2. Enter your Cycode API URL value (you can leave blank to use default value).
```bash
Cycode API URL [https://api.cycode.com]: https://api.onpremise.com
```
3. Enter your Cycode APP URL value (you can leave blank to use default value).
```bash
Cycode APP URL [https://app.cycode.com]: https://app.onpremise.com
```
4. Enter your Cycode Client ID value.
```bash
Cycode Client ID []: 7fe5346b-xxxx-xxxx-xxxx-55157625c72d
```
5. Enter your Cycode Client Secret value.
```bash
Cycode Client Secret []: c1e24929-xxxx-xxxx-xxxx-8b08c1839a2e
```
6. If the values were entered successfully, you'll see the following message:
```bash
Successfully configured CLI credentials!
```
or/and
```bash
Successfully configured Cycode URLs!
```
If you go into the `.cycode` folder under your user folder, you'll find these credentials were created and placed in the `credentials.yaml` file in that folder.
And the URLs were placed in the `config.yaml` file in that folder.
### Add to Environment Variables
#### On Unix/Linux:
```bash
export CYCODE_CLIENT_ID={your Cycode ID}
export CYCODE_CLIENT_SECRET={your Cycode Secret Key}
```
#### On Windows
1. From the Control Panel, navigate to the System menu:
2. Next, click Advanced system settings:
3. In the System Properties window that opens, click the Environment Variables button:
4. Create `CYCODE_CLIENT_ID` and `CYCODE_CLIENT_SECRET` variables with values matching your ID and Secret Key, respectively:
5. Insert the cycode.exe into the path to complete the installation.
## Install Pre-Commit Hook
Cycode’s pre-commit hook can be set up within your local repository so that the Cycode CLI application will identify any issues with your code automatically before you commit it to your codebase.
Perform the following steps to install the pre-commit hook:
1. Install the pre-commit framework:
`pip3 install pre-commit`
2. Navigate to the top directory of the local repository you wish to scan.
3. Create a new YAML file named `.pre-commit-config.yaml` (include the beginning `.`) in the repository’s top directory that contains the following:
```yaml
repos:
- repo: https://github.com/cycodehq/cycode-cli
rev: v1.4.0
hooks:
- id: cycode
stages:
- commit
```
4. Install Cycode’s hook:
`pre-commit install`
> [!NOTE]
> A successful hook installation will result in the message:<br/>
`Pre-commit installed at .git/hooks/pre-commit`
# Cycode CLI Commands
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. |
| `--help` | Show options for given command. |
| Command | Description |
|-------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------|
| [auth](#using-the-auth-command) | Authenticates your machine to associate CLI with your Cycode account. |
| [configure](#using-the-configure-command) | Initial command to authenticate your CLI client with Cycode using client ID and client secret. |
| [ignore](#ignoring-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. |
| [report](#report-command) | Generate report for SCA SBOM. |
| version | Show the version and exit. |
# Scan Command
## Running a Scan
The Cycode CLI application offers several types of scans so that you can choose the option that best fits your case. The following are the current options and commands available:
| Option | Description |
|------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `-t, --scan-type [secret\|iac\|sca\|sast]` | Specify the scan you wish to execute (`secret`/`iac`/`sca`/`sast`), the default is `secret` |
| `--secret TEXT` | Specify a Cycode client secret for this specific scan execution |
| `--client-id TEXT` | Specify a Cycode client ID for this specific scan execution |
| `--show-secret BOOLEAN` | Show secrets in plain text. See [Show/Hide Secrets](#showhide-secrets) section for more details. |
| `--soft-fail BOOLEAN` | Run scan without failing, always return a non-error status code. See [Soft Fail](#soft-fail) section for more details. |
| `--severity-threshold [INFO\|LOW\|MEDIUM\|HIGH\|CRITICAL]` | Show only violations at the specified level or higher (supported for the SCA scan type only). |
| `--sca-scan` | Specify the SCA scan you wish to execute (`package-vulnerabilities`/`license-compliance`). The default is both |
| `--monitor` | When specified, the scan results will be recorded in the knowledge graph. Please note that when working in `monitor` mode, the knowledge graph will not be updated as a result of SCM events (Push, Repo creation). (Supported for SCA scan type only). |
| `--report` | When specified, a violations report will be generated. A URL link to the report will be printed as an output to the command execution |
| `--no-restore` | When specified, Cycode will not run restore command. Will scan direct dependencies ONLY! |
| `--help` | Show options for given command. |
| Command | Description |
|----------------------------------------|-----------------------------------------------------------------|
| [commit_history](#commit-history-scan) | Scan all the commits history in this git repository |
| [path](#path-scan) | Scan the files in the path supplied in the command |
| [pre_commit](#pre-commit-scan) | Use this command to scan the content that was not committed yet |
| [repository](#repository-scan) | Scan git repository including its history |
### Repository Scan
A repository scan examines an entire local repository for any exposed secrets or insecure misconfigurations. This more holistic scan type looks at everything: the current state of your repository and its commit history. It will look not only for secrets that are currently exposed within the repository but previously deleted secrets as well.
To execute a full repository scan, execute the following:
`cycode scan repository {{path}}`
For example, consider a scenario in which you want to scan your repository stored in `~/home/git/codebase`. You could then execute the following:
`cycode scan repository ~/home/git/codebase`
The following option is available for use with this command:
| Option | Description |
|---------------------|--------------------------------------------------------|
| `-b, --branch TEXT` | Branch to scan, if not set scanning the default branch |
#### Branch Option
To scan a specific branch of your local repository, add the argument `-b` (alternatively, `--branch`) followed by the name of the branch you wish to scan.
Consider the previous example. If you wanted to only scan a branch named `dev`, you could execute the following:
`cycode scan repository ~/home/git/codebase -b dev`
or:
`cycode scan repository ~/home/git/codebase --branch dev`
### Monitor Option
> [!NOTE]
> This option is only available to SCA scans.
To push scan results tied to the [SCA policies](https://docs.cycode.com/docs/sca-policies) found in an SCA type scan to Cycode's knowledge graph, add the argument `--monitor` to the scan command.
Consider the following example. The following command will scan the repository for SCA policy violations and push them to Cycode:
`cycode scan -t sca --monitor repository ~/home/git/codebase`
or:
`cycode scan --scan-type sca --monitor repository ~/home/git/codebase`
When using this option, the scan results from this scan will appear in the knowledge graph, which can be found [here](https://app.cycode.com/query-builder).
> [!WARNING]
> You must be an `owner` or an `admin` in Cycode to view the knowledge graph page.
### Report Option
> [!NOTE]
> This option is not available to IaC scans.
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.
`cycode scan -t sca --report repository ~/home/git/codebase`
`cycode scan -t secret --report repository ~/home/git/codebase`
or:
`cycode scan --scan-type sca --report repository ~/home/git/codebase`
`cycode scan --scan-type secret --report repository ~/home/git/codebase`
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:
> :warning: **NOTE**<br/>
> You must be an `owner` or an `admin` in Cycode to view this page.
The report page will look something like below:
### Package Vulnerabilities Option
> [!NOTE]
> This option is only available to SCA scans.
To scan a specific package vulnerability of your local repository, add the argument `--sca-scan package-vulnerabilities` following the `-t sca` or `--scan-type sca` option.
Consider the previous example. If you wanted to only run an SCA scan on package vulnerabilities, you could execute the following:
`cycode scan -t sca --sca-scan package-vulnerabilities repository ~/home/git/codebase`
or:
`cycode scan --scan-type sca --sca-scan package-vulnerabilities repository ~/home/git/codebase`
#### License Compliance Option
> [!NOTE]
> This option is only available to SCA scans.
To scan a specific branch of your local repository, add the argument `--sca-scan license-compliance` followed by the name of the branch you wish to scan.
Consider the previous example. If you wanted to only scan a branch named `dev`, you could execute the following:
`cycode scan -t sca --sca-scan license-compliance repository ~/home/git/codebase -b dev`
or:
`cycode scan --scan-type sca --sca-scan license-compliance repository ~/home/git/codebase`
#### Severity Threshold
> [!NOTE]
> This option is only available to SCA scans.
To limit the results of the `sca` scan to a specific severity threshold, add the argument `--severity-threshold` to the scan command.
Consider the following example. The following command will scan the repository for SCA policy violations that have a severity of Medium or higher:
`cycode scan -t sca --security-threshold MEDIUM repository ~/home/git/codebase`
or:
`cycode scan --scan-type sca --security-threshold MEDIUM repository ~/home/git/codebase`
### Path Scan
A path scan examines a specific local directory and all the contents within it, instead of focusing solely on a GIT repository.
To execute a directory scan, execute the following:
`cycode scan path {{path}}`
For example, consider a scenario in which you want to scan the directory located at `~/home/git/codebase`. You could then execute the following:
`cycode scan path ~/home/git/codebase`
#### Terraform Plan Scan
Cycode CLI supports Terraform plan scanning (supporting Terraform 0.12 and later)
Terraform plan file must be in JSON format (having `.json` extension)
_How to generate a Terraform plan from Terraform configuration file?_
1. Initialize a working directory that contains Terraform configuration file:
`terraform init`
2. Create Terraform execution plan and save the binary output:
`terraform plan -out={tfplan_output}`
3. Convert the binary output file into readable JSON:
`terraform show -json {tfplan_output} > {tfplan}.json`
4. Scan your `{tfplan}.json` with Cycode CLI:
`cycode scan -t iac path ~/PATH/TO/YOUR/{tfplan}.json`
### Commit History Scan
A commit history scan is limited to a local repository’s previous commits, focused on finding any secrets within the commit history, instead of examining the repository’s current state.
To execute a commit history scan, execute the following:
`cycode scan commit_history {{path}}`
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:
`cycode scan commit_history ~/home/git/codebase`
The following options are available for use with this command:
| Option | Description |
|---------------------------|----------------------------------------------------------------------------------------------------------|
| `-r, --commit_range TEXT` | Scan a commit range in this git repository, by default cycode scans all commit history (example: HEAD~1) |
#### Commit Range Option
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` followed by the name you specify.
Consider the previous example. If you wanted to scan only specific commits on your repository, you could execute the following:
`cycode scan commit_history -r {{from-commit-id}}...{{to-commit-id}} ~/home/git/codebase`
OR
`cycode scan commit_history --commit_range {{from-commit-id}}...{{to-commit-id}} ~/home/git/codebase`
### Pre-Commit Scan
A pre-commit scan automatically identifies any issues before you commit changes to your repository. There is no need to manually execute this scan; simply configure the pre-commit hook as detailed under the Installation section of this guide.
After your install the pre-commit hook and, you may, on occasion, wish to skip scanning during a specific commit. Simply add the following to your `git` command to skip scanning for a single commit:
`SKIP=cycode git commit -m <your commit message>`
## Scan Results
Each scan will complete with a message stating if any issues were found or not.
If no issues are found, the scan ends with the following success message:
`Good job! No issues were found!!! 👏👏👏`
If an issue is found, a `Found issue of type:` message appears upon completion instead:
```bash
⛔ Found issue of type: generic-password (rule ID: ce3a4de0-9dfc-448b-a004-c538cf8b4710) in file: config/my_config.py
Secret SHA: a44081db3296c84b82d12a35c446a3cba19411dddfa0380134c75f7b3973bff0 ⛔
0 | @@ -0,0 +1 @@
1 | +my_password = 'h3l***********350'
2 | \ No newline at end of file
```
In the event an issue is found, review the file in question for the specific line highlighted by the result message. Implement any changes required to resolve the issue, then execute the scan again.
### Show/Hide Secrets
In the above example, a secret was found in the file `secret_test`, located in the subfolder `cli`. The second part of the message shows the specific line the secret appears in, which in this case is a value assigned to `googleApiKey`.
Note how the above example obscures the actual secret value, replacing most of the secret with asterisks. Scans obscure secrets by default, but you may optionally disable this feature in order to view the full secret (assuming the machine you are viewing the scan result on is sufficiently secure from prying eyes).
To disable secret obfuscation, add the `--show-secret` argument to any type of scan, then assign it a `1` value to show the full secret in the result message, or `0` to hide the secret (which is done by default).
In the following example, a Path Scan is executed against the `cli` subdirectory with the option enabled to display any secrets found in full:
`cycode scan --show-secret=1 path ./cli`
The result would then not be obfuscated:
```bash
⛔ Found issue of type: generic-password (rule ID: ce3a4de0-9dfc-448b-a004-c538cf8b4710) in file: config/my_config.py
Secret SHA: a44081db3296c84b82d12a35c446a3cba19411dddfa0380134c75f7b3973bff0 ⛔
0 | @@ -0,0 +1 @@
1 | +my_password = 'h3110w0r1d!@#$350'
2 | \ No newline at end of file
```
### Soft Fail
Utilizing the soft fail feature will not fail the CI/CD step within the pipeline if the Cycode scan finds an issue. Additionally, in case an issue occurs from Cycode’s side, a soft fail will automatically execute to avoid interference.
Add the `--soft-fail` argument to any type of scan to configure this feature, then assign a value of `1` if you want found issues to result in a failure within the CI/CD tool or `0` for scan results to have no impact (result in a `success` result).
### Example Scan Results
#### Secrets Result Example
```bash
⛔ Found issue of type: generic-password (rule ID: ce3a4de0-9dfc-448b-a004-c538cf8b4710) in file: config/my_config.py
Secret SHA: a44081db3296c84b82d12a35c446a3cba19411dddfa0380134c75f7b3973bff0 ⛔
0 | @@ -0,0 +1 @@
1 | +my_password = 'h3l***********350'
2 | \ No newline at end of file
```
#### IaC Result Example
```bash
⛔ Found issue of type: Resource should use non-default namespace (rule ID: bdaa88e2-5e7c-46ff-ac2a-29721418c59c) in file: ./k8s/k8s.yaml ⛔
7 | name: secrets-file
8 | namespace: default
9 | resourceVersion: "4228"
```
#### SCA Result Example
```bash
⛔ Found issue of type: Security vulnerability in package 'pyyaml' referenced in project 'Users/myuser/my-test-repo': Improper Input Validation in PyYAML (rule ID: d003b23a-a2eb-42f3-83c9-7a84505603e5) in file: Users/myuser/my-test-repo/requirements.txt ⛔
1 | PyYAML~=5.3.1
2 | vyper==0.3.1
3 | cleo==1.0.0a5
```
#### SAST Result Example
```bash
⛔ Found issue of type: Detected a request using 'http://'. This request will be unencrypted, and attackers could listen into traffic on the network and be able to obtain sensitive information. Use 'https://' instead. (rule ID: 3fbbd34b-b00d-4415-b9d9-f861c076b9f2) in file: ./requests.py ⛔
2 |
3 | res = requests.get('http://example.com', timeout=1)
4 | print(res.content)
```
### Company’s Custom Remediation Guidelines
If your company has set custom remediation guidelines in the relevant policy via the Cycode portal, you'll see a field for “Company Guidelines” that contains the remediation guidelines you added. Note that if you haven't added any company guideline, this field will not appear in the CLI tool.
## Ignoring Scan Results
Ignore rules can be added to ignore specific secret values, specific SHA512 values, specific paths, and specific Cycode secret and IaC rule IDs. This will cause the scan to not alert these values. The ignore rules are written and saved locally in the `./.cycode/config.yaml` file.
> :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 |
|--------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `--by-value TEXT` | Ignore a specific value while scanning for secrets. See [Ignoring a Secret Value](#ignoring-a-secret-value) for more details. |
| `--by-sha TEXT` | Ignore a specific SHA512 representation of a string while scanning for secrets. See [Ignoring a Secret SHA Value](#ignoring-a-secret-sha-value) for more details. |
| `--by-path TEXT` | Avoid scanning a specific path. Need to specify scan type. See [Ignoring a Path](#ignoring-a-path) for more details. |
| `--by-rule TEXT` | Ignore scanning a specific secret rule ID/IaC rule ID/SCA rule ID. See [Ignoring a Secret or Iac Rule](#ignoring-a-secret-iac-sca-or-sast-rule) for more details. |
| `--by-package TEXT` | Ignore scanning a specific package version while running an SCA scan. Expected pattern - `name@version`. See [Ignoring a Package](#ignoring-a-package) for more details. |
| `-t, --scan-type [secret\|iac\|sca\|sast]` | Specify the scan you wish to execute (`secret`/`iac`/`sca`/`sast`), The default value is `secret` |
| `-g, --global` | Add an ignore rule and update it in the global `.cycode` config file |
In the following example, a pre-commit scan runs and finds the following:
```bash
⛔ Found issue of type: generic-password (rule ID: ce3a4de0-9dfc-448b-a004-c538cf8b4710) in file: config/my_config.py
Secret SHA: a44081db3296c84b82d12a35c446a3cba19411dddfa0380134c75f7b3973bff0 ⛔
0 | @@ -0,0 +1 @@
1 | +my_password = 'h3l***********350'
2 | \ No newline at end of file
```
If this is a value that is not a valid secret, then use the `cycode ignore` command to ignore the secret by its value, SHA value, specific path, or rule ID. If this is an IaC scan, then you can ignore that result by its path or rule ID.
### Ignoring a Secret Value
To ignore a specific secret value, you will need to use the `--by-value` flag. This will ignore the given secret value from all future scans. Use the following command to add a secret value to be ignored:
`cycode ignore --by-value {{secret-value}}`
In the example at the top of this section, the command to ignore a specific secret value is as follows:
`cycode ignore --by-value h3110w0r1d!@#$350`
In the example above, replace the `h3110w0r1d!@#$350` value with your non-masked secret value. See the Cycode scan options for details on how to see secret values in the scan results.
### Ignoring a Secret SHA Value
To ignore a specific secret SHA value, you will need to use the `--by-sha` flag. This will ignore the given secret SHA value from all future scans. Use the following command to add a secret SHA value to be ignored:
`cycode ignore --by-sha {{secret-sha-value}}`
In the example at the top of this section, the command to ignore a specific secret SHA value is as follows:
`cycode ignore --by-sha a44081db3296c84b82d12a35c446a3cba19411dddfa0380134c75f7b3973bff0`
In the example above, replace the `a44081db3296c84b82d12a35c446a3cba19411dddfa0380134c75f7b3973bff0` value with your secret SHA value.
### Ignoring a Path
To ignore a specific path for either secret, IaC, or SCA scans, you will need to use the `--by-path` flag in conjunction with the `-t, --scan-type` flag (you must specify the scan type). This will ignore the given path from all future scans for the given scan type. Use the following command to add a path to be ignored:
`cycode ignore -t {{scan-type}} --by-path {{path}}`
OR
`cycode ignore --scan-type {{scan-type}} --by-path {{path}}`
In the example at the top of this section, the command to ignore a specific path for a secret is as follows:
`cycode ignore -t secret --by-path ~/home/my-repo/config`
In the example above, replace the `~/home/my-repo/config` value with your path value.
In the example at the top of this section, the command to ignore a specific path from IaC scans is as follows:
`cycode ignore -t iac --by-path ~/home/my-repo/config`
In the example above, replace the `~/home/my-repo/config` value with your path value.
In the example at the top of this section, the command to ignore a specific path from SCA scans is as follows:
`cycode ignore -t sca --by-path ~/home/my-repo/config`
In the example above, replace the `~/home/my-repo/config` value with your path value.
### Ignoring a Secret, IaC, SCA, or SAST Rule
To ignore a specific secret, IaC, SCA, or SAST rule, you will need to use the `--by-rule` flag in conjunction with the `-t, --scan-type` flag (you must specify the scan type). This will ignore the given rule ID value from all future scans. Use the following command to add a rule ID value to be ignored:
`cycode ignore -t {{scan-type}} --by-rule {{rule-ID}}`
OR
`cycode ignore --scan-type {{scan-type}} --by-rule {{rule-ID}}`
In the example at the top of this section, the command to ignore the specific secret rule ID is as follows:
`cycode ignore --scan-type secret --by-rule ce3a4de0-9dfc-448b-a004-c538cf8b4710`
In the example above, replace the `ce3a4de0-9dfc-448b-a004-c538cf8b4710` value with the rule ID you want to ignore.
In the example at the top of this section, the command to ignore the specific IaC rule ID is as follows:
`cycode ignore --scan-type iac --by-rule bdaa88e2-5e7c-46ff-ac2a-29721418c59c`
In the example above, replace the `bdaa88e2-5e7c-46ff-ac2a-29721418c59c` value with the rule ID you want to ignore.
In the example at the top of this section, the command to ignore the specific SCA rule ID is as follows:
`cycode ignore --scan-type sca --by-rule dc21bc6b-9f4f-46fb-9f92-e4327ea03f6b`
In the example above, replace the `dc21bc6b-9f4f-46fb-9f92-e4327ea03f6b` value with the rule ID you want to ignore.
### Ignoring a Package
> [!NOTE]
> This option is only available to the SCA scans.
To ignore a specific package in the SCA scans, you will need to use the `--by-package` flag in conjunction with the `-t, --scan-type` flag (you must specify the `sca` scan type). This will ignore the given package, using the `{{package_name}}@{{package_version}}` formatting, from all future scans. Use the following command to add a package and version to be ignored:
`cycode ignore --scan-type sca --by-package {{package_name}}@{{package_version}}`
OR
`cycode ignore -t sca --by-package {{package_name}}@{{package_version}}`
In the example below, the command to ignore a specific SCA package is as follows:
`cycode ignore --scan-type sca --by-package pyyaml@5.3.1`
In the example above, replace `pyyaml` with package name and `5.3.1` with the package version you want to ignore.
### Ignoring using config file
The applied ignoring rules are stored in the configuration file called `config.yaml`.
This file could be easily shared between developers or even committed to remote Git.
These files are always located in the `.cycode` folder.
The folder starts with a dot (.), and you should enable the displaying of hidden files to see it.
#### Path of the config files
By default, all `cycode ignore` commands save the ignoring rule to the current directory from which CLI has been run.
Example: running ignoring CLI command from `/Users/name/projects/backend` will create `config.yaml` in `/Users/name/projects/backend/.cycode`
```shell
➜ backend pwd
/Users/name/projects/backend
➜ backend cycode ignore --by-value test-value
➜ backend tree -a
.
└── .cycode
└── config.yaml
2 directories, 1 file
```
The second option is to save ignoring rules to the global configuration files.
The path of the global config is `~/.cycode/config.yaml`,
where `~` means user\`s home directory, for example, `/Users/name` on macOS.
Saving to the global space could be performed with the `-g` flag of the `cycode ignore` command.
For example: `cycode ignore -g --by-value test-value`.
#### Proper working directory
This is incredibly important to place the `.cycode` folder and run CLI from the same place.
You should double-check it when working with different environments like CI/CD (GitHub Actions, Jenkins, etc.).
You could commit the `.cycode` folder to the root of your repository.
In this scenario, you must run CLI scans from the repository root.
If it doesn't fit your requirements, you could temporarily copy the `.cycode` folder
wherever you want and perform a CLI scan from this folder.
#### Structure ignoring rules in the config
It's important to understand how CLI stores ignore rules to be able to read these configuration files or even modify them without CLI.
The abstract YAML structure:
```yaml
exclusions:
*scanTypeName*:
*ignoringType:
- *ignoringValue1*
- *ignoringValue2*
```
Possible values of `scanTypeName`: `iac`, `sca`, `sast`, `secret`.
Possible values of `ignoringType`: `paths`, `values`, `rules`, `packages`, `shas`.
> [!WARNING]
> Values for "ignore by value" are not stored as plain text!
> CLI stores sha256 hashes of the values instead.
> You should put hashes of the string when modifying the configuration file by hand.
Example of real `config.yaml`:
```yaml
exclusions:
iac:
rules:
- bdaa88e2-5e7c-46ff-ac2a-29721418c59c
sca:
packages:
- pyyaml@5.3.1
secret:
paths:
- /Users/name/projects/build
rules:
- ce3a4de0-9dfc-448b-a004-c538cf8b4710
shas:
- a44081db3296c84b82d12a35c446a3cba19411dddfa0380134c75f7b3973bff0
values:
- a665a45920422f9d417e4867efdc4fb8a04a1f3fff1fa07e998e86f7f7a27ae3
- 60303ae22b998861bce3b28f33eec1be758a213c86c93c076dbe9f558c11c752
```
# Report Command
## Generating SBOM Report
A software bill of materials (SBOM) is an inventory of all constituent components and software dependencies involved in the development and delivery of an application.
Using this command you can create an SBOM report for your local project or for your repository URI.
The following options are available for use with this command:
| Option | Description | Required | Default |
|----------------------------------------------------|--------------------------------|----------|-------------------------------------------------------|
| `-f, --format [spdx-2.2\|spdx-2.3\|cyclonedx-1.4]` | SBOM format | Yes | |
| `-o, --output-format [JSON]` | Specify the output file format | No | json |
| `--output-file PATH` | Output file | No | autogenerated filename saved to the current directory |
| `--include-vulnerabilities` | Include vulnerabilities | No | False |
| `--include-dev-dependencies` | Include dev dependencies | No | False |
The following commands are available for use with this command:
| Command | Description |
|------------------|-----------------------------------------------------------------|
| `path` | Generate SBOM report for provided path in the command |
| `repository_url` | Generate SBOM report for provided repository URI in the command |
### Repository
To create an SBOM report for a repository URI:\
`cycode report sbom --format <sbom format> --include-vulnerabilities --include-dev-dependencies --output-file </path/to/file> repository_url <repository url>`
For example:\
`cycode report sbom --format spdx-2.3 --include-vulnerabilities --include-dev-dependencies repository_url https://github.com/cycodehq/cycode-cli.git`
### Local Project
To create an SBOM report for a path:\
`cycode report sbom --format <sbom format> --include-vulnerabilities --include-dev-dependencies --output-file </path/to/file> path </path/to/project>`
For example:\
`cycode report sbom --format spdx-2.3 --include-vulnerabilities --include-dev-dependencies path /path/to/local/project`
# Syntax Help
You may add the `--help` argument to any command at any time to see a help message that will display available options and their syntax.
To see general help, simply enter the command:
`cycode --help`
To see scan options, enter:
`cycode scan --help`
To see the options available for a specific type of scan, enter:
`cycode scan {{option}} --help`
For example, to see options available for a Path Scan, you would simply enter:
`cycode scan path --help`
To see the options available for the ignore scan function, use this command:
`cycode ignore --help`
To see the options available for report, use this command:
`cycode report --help`
To see the options available for a specific type of report, enter:
`cycode scan {{option}} --help`
Raw data
{
"_id": null,
"home_page": "https://github.com/cycodehq/cycode-cli",
"name": "cycode",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.13,>=3.7",
"maintainer_email": null,
"keywords": "secret-scan, cycode, devops, token, secret, security, cycode, code",
"author": "Cycode",
"author_email": "support@cycode.com",
"download_url": "https://files.pythonhosted.org/packages/83/85/d4c6f2b8a97b2ae2eeb88091ec5c1d15245eac50843cfe1ab860edf6ca30/cycode-1.9.5.tar.gz",
"platform": null,
"description": "# Cycode CLI User Guide\n\nThe Cycode Command Line Interface (CLI) is an application you can install on your local machine which can scan your locally stored repositories for any secrets or infrastructure as code misconfigurations.\n\nThis guide will guide you through both installation and usage.\n\n# Table of Contents\n\n1. [Prerequisites](#prerequisites)\n2. [Installation](#installation)\n 1. [Install Cycode CLI](#install-cycode-cli)\n 1. [Using the Auth Command](#using-the-auth-command)\n 2. [Using the Configure Command](#using-the-configure-command)\n 3. [Add to Environment Variables](#add-to-environment-variables)\n 1. [On Unix/Linux](#on-unixlinux)\n 2. [On Windows](#on-windows)\n 2. [Install Pre-Commit Hook](#install-pre-commit-hook)\n3. [Cycode Command](#cycode-cli-commands)\n4. [Scan Command](#scan-command)\n 1. [Running a Scan](#running-a-scan)\n 1. [Repository Scan](#repository-scan)\n 1. [Branch Option](#branch-option)\n 2. [Monitor Option](#monitor-option)\n 3. [Report Option](#report-option)\n 4. [Package Vulnerabilities Scan](#package-vulnerabilities-option)\n 1. [License Compliance Option](#license-compliance-option)\n 2. [Severity Threshold](#severity-threshold)\n 5. [Path Scan](#path-scan)\n 1. [Terraform Plan Scan](#terraform-plan-scan)\n 6. [Commit History Scan](#commit-history-scan)\n 1. [Commit Range Option](#commit-range-option)\n 7. [Pre-Commit Scan](#pre-commit-scan)\n 2. [Scan Results](#scan-results)\n 1. [Show/Hide Secrets](#showhide-secrets)\n 2. [Soft Fail](#soft-fail)\n 3. [Example Scan Results](#example-scan-results)\n 1. [Secrets Result Example](#secrets-result-example)\n 2. [IaC Result Example](#iac-result-example)\n 3. [SCA Result Example](#sca-result-example)\n 4. [SAST Result Example](#sast-result-example)\n 4. [Company\u2019s Custom Remediation Guidelines](#companys-custom-remediation-guidelines) \n 3. [Ignoring Scan Results](#ignoring-scan-results)\n 1. [Ignoring a Secret Value](#ignoring-a-secret-value)\n 2. [Ignoring a Secret SHA Value](#ignoring-a-secret-sha-value)\n 3. [Ignoring a Path](#ignoring-a-path)\n 4. [Ignoring a Secret, IaC, or SCA Rule](#ignoring-a-secret-iac-sca-or-sast-rule)\n 5. [Ignoring a Package](#ignoring-a-package)\n 6. [Ignoring using config file](#ignoring-using-config-file)\n5. [Report command](#report-command)\n 1. [Generating SBOM Report](#generating-sbom-report)\n6. [Syntax Help](#syntax-help)\n\n# Prerequisites\n\n> [!WARNING] \n> Python 3.7 end-of-life was on 2023-06-27. \n> It is recommended to use Python 3.8 or later. \n> We will drop support for Python 3.7 soon.\n\n- The Cycode CLI application requires Python version 3.7 or later.\n- Use the [`cycode auth` command](#using-the-auth-command) to authenticate to Cycode with the CLI\n - Alternatively, you can obtain a Cycode Client ID and Client Secret Key by following the steps detailed in the [Service Account Token](https://docs.cycode.com/reference/creating-a-service-account-access-token) and [Personal Access Token](https://docs.cycode.com/reference/creating-a-personal-access-token-1) pages, which contain details on obtaining these values.\n\n# Installation\n\nThe following installation steps are applicable to both Windows and UNIX / Linux operating systems.\n\n> [!NOTE]\n> The following steps assume the use of `python3` and `pip3` for Python-related commands; however, some systems may instead use the `python` and `pip` commands, depending on your Python environment\u2019s configuration.\n\n## Install Cycode CLI\n\nTo install the Cycode CLI application on your local machine, perform the following steps:\n\n1. Open your command line or terminal application.\n\n2. Execute one of the following commands:\n\n - `pip3 install cycode` - to install from PyPI\n - `brew install cycode` - to install from Homebrew\n\n3. Navigate to the top directory of the local repository you wish to scan.\n\n4. There are three methods to set the Cycode client ID and client secret:\n\n - [cycode auth](#using-the-auth-command) (**Recommended**)\n - [cycode configure](#using-the-configure-command)\n - Add them to your [environment variables](#add-to-environment-variables)\n\n### Using the Auth Command\n\n> [!NOTE]\n> This is the **recommended** method for setting up your local machine to authenticate with Cycode CLI.\n\n1. Type the following command into your terminal/command line window:\n\n `cycode auth`\n\n2. A browser window will appear, asking you to log into Cycode (as seen below):\n\n \n\n3. Enter your login credentials on this page and log in.\n\n4. You will eventually be taken to the page below, where you'll be asked to choose the business group you want to authorize Cycode with (if applicable):\n\n \n\n > [!NOTE]\n > This will be the default method for authenticating with the Cycode CLI.\n\n5. Click the **Allow** button to authorize the Cycode CLI on the selected business group.\n\n \n\n6. Once completed, you'll see the following screen, if it was selected successfully:\n\n \n\n7. In the terminal/command line screen, you will see the following when exiting the browser window:\n\n ```bash\n Successfully logged into cycode\n ```\n\n### Using the Configure Command\n\n> [!NOTE]\n> If you already set up your Cycode Client ID and Client Secret through the Linux or Windows environment variables, those credentials will take precedent over this method.\n\n1. Type the following command into your terminal/command line window:\n\n `cycode configure`\n\n2. Enter your Cycode API URL value (you can leave blank to use default value).\n\n ```bash\n Cycode API URL [https://api.cycode.com]: https://api.onpremise.com\n ```\n\n3. Enter your Cycode APP URL value (you can leave blank to use default value).\n\n ```bash\n Cycode APP URL [https://app.cycode.com]: https://app.onpremise.com\n ```\n\n4. Enter your Cycode Client ID value.\n\n ```bash\n Cycode Client ID []: 7fe5346b-xxxx-xxxx-xxxx-55157625c72d\n ```\n\n5. Enter your Cycode Client Secret value.\n\n ```bash\n Cycode Client Secret []: c1e24929-xxxx-xxxx-xxxx-8b08c1839a2e\n ```\n\n6. If the values were entered successfully, you'll see the following message:\n\n ```bash\n Successfully configured CLI credentials!\n ```\n\n or/and\n\n ```bash\n Successfully configured Cycode URLs!\n ```\n\nIf you go into the `.cycode` folder under your user folder, you'll find these credentials were created and placed in the `credentials.yaml` file in that folder. \nAnd the URLs were placed in the `config.yaml` file in that folder.\n\n### Add to Environment Variables\n\n#### On Unix/Linux:\n\n```bash\nexport CYCODE_CLIENT_ID={your Cycode ID}\nexport CYCODE_CLIENT_SECRET={your Cycode Secret Key}\n```\n\n#### On Windows\n\n1. From the Control Panel, navigate to the System menu:\n\n \n\n2. Next, click Advanced system settings:\n\n \n\n3. In the System Properties window that opens, click the Environment Variables button:\n\n \n\n4. Create `CYCODE_CLIENT_ID` and `CYCODE_CLIENT_SECRET` variables with values matching your ID and Secret Key, respectively:\n\n \n\n5. Insert the cycode.exe into the path to complete the installation.\n \n## Install Pre-Commit Hook\n\nCycode\u2019s pre-commit hook can be set up within your local repository so that the Cycode CLI application will identify any issues with your code automatically before you commit it to your codebase.\n\nPerform the following steps to install the pre-commit hook:\n\n1. Install the pre-commit framework:\n\n `pip3 install pre-commit`\n\n2. Navigate to the top directory of the local repository you wish to scan.\n\n3. Create a new YAML file named `.pre-commit-config.yaml` (include the beginning `.`) in the repository\u2019s top directory that contains the following:\n\n ```yaml\n repos:\n - repo: https://github.com/cycodehq/cycode-cli\n rev: v1.4.0\n hooks:\n - id: cycode\n stages:\n - commit\n ```\n\n4. Install Cycode\u2019s hook:\n\n `pre-commit install`\n\n> [!NOTE]\n> A successful hook installation will result in the message:<br/>\n`Pre-commit installed at .git/hooks/pre-commit`\n\n# Cycode CLI Commands\n\nThe following are the options and commands available with the Cycode CLI application:\n\n| Option | Description |\n|--------------------------------------|--------------------------------------------------------------------|\n| `-o`, `--output [text\\|json\\|table]` | Specify the output (`text`/`json`/`table`). The default is `text`. |\n| `-v`, `--verbose` | Show detailed logs. |\n| `--help` | Show options for given command. |\n\n| Command | Description |\n|-------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------|\n| [auth](#using-the-auth-command) | Authenticates your machine to associate CLI with your Cycode account. |\n| [configure](#using-the-configure-command) | Initial command to authenticate your CLI client with Cycode using client ID and client secret. |\n| [ignore](#ignoring-scan-results) | Ignore a specific value, path or rule ID. |\n| [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. |\n| [report](#report-command) | Generate report for SCA SBOM. |\n| version | Show the version and exit. |\n\n# Scan Command\n\n## Running a Scan\n\nThe Cycode CLI application offers several types of scans so that you can choose the option that best fits your case. The following are the current options and commands available:\n\n| Option | Description |\n|------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `-t, --scan-type [secret\\|iac\\|sca\\|sast]` | Specify the scan you wish to execute (`secret`/`iac`/`sca`/`sast`), the default is `secret` |\n| `--secret TEXT` | Specify a Cycode client secret for this specific scan execution |\n| `--client-id TEXT` | Specify a Cycode client ID for this specific scan execution |\n| `--show-secret BOOLEAN` | Show secrets in plain text. See [Show/Hide Secrets](#showhide-secrets) section for more details. |\n| `--soft-fail BOOLEAN` | Run scan without failing, always return a non-error status code. See [Soft Fail](#soft-fail) section for more details. |\n| `--severity-threshold [INFO\\|LOW\\|MEDIUM\\|HIGH\\|CRITICAL]` | Show only violations at the specified level or higher (supported for the SCA scan type only). |\n| `--sca-scan` | Specify the SCA scan you wish to execute (`package-vulnerabilities`/`license-compliance`). The default is both |\n| `--monitor` | When specified, the scan results will be recorded in the knowledge graph. Please note that when working in `monitor` mode, the knowledge graph will not be updated as a result of SCM events (Push, Repo creation). (Supported for SCA scan type only). |\n| `--report` | When specified, a violations report will be generated. A URL link to the report will be printed as an output to the command execution |\n| `--no-restore` | When specified, Cycode will not run restore command. Will scan direct dependencies ONLY! |\n| `--help` | Show options for given command. |\n\n| Command | Description |\n|----------------------------------------|-----------------------------------------------------------------|\n| [commit_history](#commit-history-scan) | Scan all the commits history in this git repository |\n| [path](#path-scan) | Scan the files in the path supplied in the command |\n| [pre_commit](#pre-commit-scan) | Use this command to scan the content that was not committed yet |\n| [repository](#repository-scan) | Scan git repository including its history |\n\n### Repository Scan\n\nA repository scan examines an entire local repository for any exposed secrets or insecure misconfigurations. This more holistic scan type looks at everything: the current state of your repository and its commit history. It will look not only for secrets that are currently exposed within the repository but previously deleted secrets as well.\n\nTo execute a full repository scan, execute the following:\n\n`cycode scan repository {{path}}`\n\nFor example, consider a scenario in which you want to scan your repository stored in `~/home/git/codebase`. You could then execute the following:\n\n`cycode scan repository ~/home/git/codebase`\n\nThe following option is available for use with this command:\n\n| Option | Description |\n|---------------------|--------------------------------------------------------|\n| `-b, --branch TEXT` | Branch to scan, if not set scanning the default branch |\n\n#### Branch Option\n\nTo scan a specific branch of your local repository, add the argument `-b` (alternatively, `--branch`) followed by the name of the branch you wish to scan.\n\nConsider the previous example. If you wanted to only scan a branch named `dev`, you could execute the following:\n\n`cycode scan repository ~/home/git/codebase -b dev`\n\nor:\n\n`cycode scan repository ~/home/git/codebase --branch dev`\n\n### Monitor Option\n\n> [!NOTE]\n> This option is only available to SCA scans.\n\nTo push scan results tied to the [SCA policies](https://docs.cycode.com/docs/sca-policies) found in an SCA type scan to Cycode's knowledge graph, add the argument `--monitor` to the scan command.\n\nConsider the following example. The following command will scan the repository for SCA policy violations and push them to Cycode:\n\n`cycode scan -t sca --monitor repository ~/home/git/codebase`\n\nor:\n\n`cycode scan --scan-type sca --monitor repository ~/home/git/codebase`\n\nWhen using this option, the scan results from this scan will appear in the knowledge graph, which can be found [here](https://app.cycode.com/query-builder).\n\n> [!WARNING]\n> You must be an `owner` or an `admin` in Cycode to view the knowledge graph page.\n\n### Report Option\n\n> [!NOTE]\n> This option is not available to IaC scans.\n\nTo 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.\n\n`cycode scan -t sca --report repository ~/home/git/codebase`\n`cycode scan -t secret --report repository ~/home/git/codebase`\n\nor:\n\n`cycode scan --scan-type sca --report repository ~/home/git/codebase`\n`cycode scan --scan-type secret --report repository ~/home/git/codebase`\n\nWhen 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:\n\n> :warning: **NOTE**<br/>\n> You must be an `owner` or an `admin` in Cycode to view this page.\n\n\n\n\nThe report page will look something like below:\n\n\n\n### Package Vulnerabilities Option\n\n> [!NOTE]\n> This option is only available to SCA scans.\n\nTo scan a specific package vulnerability of your local repository, add the argument `--sca-scan package-vulnerabilities` following the `-t sca` or `--scan-type sca` option.\n\nConsider the previous example. If you wanted to only run an SCA scan on package vulnerabilities, you could execute the following:\n\n`cycode scan -t sca --sca-scan package-vulnerabilities repository ~/home/git/codebase`\n\nor:\n\n`cycode scan --scan-type sca --sca-scan package-vulnerabilities repository ~/home/git/codebase`\n\n#### License Compliance Option\n\n> [!NOTE]\n> This option is only available to SCA scans.\n\nTo scan a specific branch of your local repository, add the argument `--sca-scan license-compliance` followed by the name of the branch you wish to scan.\n\nConsider the previous example. If you wanted to only scan a branch named `dev`, you could execute the following:\n\n`cycode scan -t sca --sca-scan license-compliance repository ~/home/git/codebase -b dev`\n\nor:\n\n`cycode scan --scan-type sca --sca-scan license-compliance repository ~/home/git/codebase`\n\n#### Severity Threshold\n\n> [!NOTE]\n> This option is only available to SCA scans.\n\nTo limit the results of the `sca` scan to a specific severity threshold, add the argument `--severity-threshold` to the scan command.\n\nConsider the following example. The following command will scan the repository for SCA policy violations that have a severity of Medium or higher:\n\n`cycode scan -t sca --security-threshold MEDIUM repository ~/home/git/codebase`\n\nor:\n\n`cycode scan --scan-type sca --security-threshold MEDIUM repository ~/home/git/codebase`\n\n### Path Scan\n\nA path scan examines a specific local directory and all the contents within it, instead of focusing solely on a GIT repository.\n\nTo execute a directory scan, execute the following:\n\n`cycode scan path {{path}}`\n\nFor example, consider a scenario in which you want to scan the directory located at `~/home/git/codebase`. You could then execute the following:\n\n`cycode scan path ~/home/git/codebase`\n\n\n#### Terraform Plan Scan\n\nCycode CLI supports Terraform plan scanning (supporting Terraform 0.12 and later)\n\nTerraform plan file must be in JSON format (having `.json` extension)\n\n_How to generate a Terraform plan from Terraform configuration file?_\n \n1. Initialize a working directory that contains Terraform configuration file:\n\n `terraform init`\n\n2. Create Terraform execution plan and save the binary output:\n\n `terraform plan -out={tfplan_output}`\n\n3. Convert the binary output file into readable JSON:\n\n `terraform show -json {tfplan_output} > {tfplan}.json`\n\n4. Scan your `{tfplan}.json` with Cycode CLI:\n\n `cycode scan -t iac path ~/PATH/TO/YOUR/{tfplan}.json`\n\n### Commit History Scan\n\nA commit history scan is limited to a local repository\u2019s previous commits, focused on finding any secrets within the commit history, instead of examining the repository\u2019s current state.\n\nTo execute a commit history scan, execute the following:\n\n`cycode scan commit_history {{path}}`\n\nFor 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:\n\n`cycode scan commit_history ~/home/git/codebase`\n\nThe following options are available for use with this command:\n\n| Option | Description |\n|---------------------------|----------------------------------------------------------------------------------------------------------|\n| `-r, --commit_range TEXT` | Scan a commit range in this git repository, by default cycode scans all commit history (example: HEAD~1) |\n\n#### Commit Range Option\n\nThe commit history scan, by default, examines the repository\u2019s 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` followed by the name you specify.\n\nConsider the previous example. If you wanted to scan only specific commits on your repository, you could execute the following:\n\n`cycode scan commit_history -r {{from-commit-id}}...{{to-commit-id}} ~/home/git/codebase`\n\nOR\n\n`cycode scan commit_history --commit_range {{from-commit-id}}...{{to-commit-id}} ~/home/git/codebase`\n\n### Pre-Commit Scan\n\nA pre-commit scan automatically identifies any issues before you commit changes to your repository. There is no need to manually execute this scan; simply configure the pre-commit hook as detailed under the Installation section of this guide.\n\nAfter your install the pre-commit hook and, you may, on occasion, wish to skip scanning during a specific commit. Simply add the following to your `git` command to skip scanning for a single commit:\n\n`SKIP=cycode git commit -m <your commit message>`\n\n## Scan Results\n\nEach scan will complete with a message stating if any issues were found or not.\n\nIf no issues are found, the scan ends with the following success message:\n\n`Good job! No issues were found!!! \ud83d\udc4f\ud83d\udc4f\ud83d\udc4f`\n\nIf an issue is found, a `Found issue of type:` message appears upon completion instead:\n\n```bash\n\u26d4 Found issue of type: generic-password (rule ID: ce3a4de0-9dfc-448b-a004-c538cf8b4710) in file: config/my_config.py\nSecret SHA: a44081db3296c84b82d12a35c446a3cba19411dddfa0380134c75f7b3973bff0 \u26d4\n0 | @@ -0,0 +1 @@\n1 | +my_password = 'h3l***********350'\n2 | \\ No newline at end of file\n```\n\nIn the event an issue is found, review the file in question for the specific line highlighted by the result message. Implement any changes required to resolve the issue, then execute the scan again.\n\n### Show/Hide Secrets\n\nIn the above example, a secret was found in the file `secret_test`, located in the subfolder `cli`. The second part of the message shows the specific line the secret appears in, which in this case is a value assigned to `googleApiKey`.\n\nNote how the above example obscures the actual secret value, replacing most of the secret with asterisks. Scans obscure secrets by default, but you may optionally disable this feature in order to view the full secret (assuming the machine you are viewing the scan result on is sufficiently secure from prying eyes).\n\nTo disable secret obfuscation, add the `--show-secret` argument to any type of scan, then assign it a `1` value to show the full secret in the result message, or `0` to hide the secret (which is done by default).\n\nIn the following example, a Path Scan is executed against the `cli` subdirectory with the option enabled to display any secrets found in full:\n\n`cycode scan --show-secret=1 path ./cli`\n\nThe result would then not be obfuscated:\n\n```bash\n\u26d4 Found issue of type: generic-password (rule ID: ce3a4de0-9dfc-448b-a004-c538cf8b4710) in file: config/my_config.py\nSecret SHA: a44081db3296c84b82d12a35c446a3cba19411dddfa0380134c75f7b3973bff0 \u26d4\n0 | @@ -0,0 +1 @@\n1 | +my_password = 'h3110w0r1d!@#$350'\n2 | \\ No newline at end of file\n```\n\n### Soft Fail\n\nUtilizing the soft fail feature will not fail the CI/CD step within the pipeline if the Cycode scan finds an issue. Additionally, in case an issue occurs from Cycode\u2019s side, a soft fail will automatically execute to avoid interference.\n\nAdd the `--soft-fail` argument to any type of scan to configure this feature, then assign a value of `1` if you want found issues to result in a failure within the CI/CD tool or `0` for scan results to have no impact (result in a `success` result).\n\n### Example Scan Results\n\n#### Secrets Result Example\n\n```bash\n\u26d4 Found issue of type: generic-password (rule ID: ce3a4de0-9dfc-448b-a004-c538cf8b4710) in file: config/my_config.py\nSecret SHA: a44081db3296c84b82d12a35c446a3cba19411dddfa0380134c75f7b3973bff0 \u26d4\n0 | @@ -0,0 +1 @@\n1 | +my_password = 'h3l***********350'\n2 | \\ No newline at end of file\n```\n\n#### IaC Result Example\n\n```bash\n\u26d4 Found issue of type: Resource should use non-default namespace (rule ID: bdaa88e2-5e7c-46ff-ac2a-29721418c59c) in file: ./k8s/k8s.yaml \u26d4\n\n7 | name: secrets-file\n8 | namespace: default\n9 | resourceVersion: \"4228\"\n```\n\n#### SCA Result Example\n\n```bash\n\u26d4 Found issue of type: Security vulnerability in package 'pyyaml' referenced in project 'Users/myuser/my-test-repo': Improper Input Validation in PyYAML (rule ID: d003b23a-a2eb-42f3-83c9-7a84505603e5) in file: Users/myuser/my-test-repo/requirements.txt \u26d4\n\n1 | PyYAML~=5.3.1\n2 | vyper==0.3.1\n3 | cleo==1.0.0a5\n```\n\n#### SAST Result Example\n\n```bash\n\u26d4 Found issue of type: Detected a request using 'http://'. This request will be unencrypted, and attackers could listen into traffic on the network and be able to obtain sensitive information. Use 'https://' instead. (rule ID: 3fbbd34b-b00d-4415-b9d9-f861c076b9f2) in file: ./requests.py \u26d4\n\n2 |\n3 | res = requests.get('http://example.com', timeout=1)\n4 | print(res.content)\n```\n\n### Company\u2019s Custom Remediation Guidelines\n\nIf your company has set custom remediation guidelines in the relevant policy via the Cycode portal, you'll see a field for \u201cCompany Guidelines\u201d that contains the remediation guidelines you added. Note that if you haven't added any company guideline, this field will not appear in the CLI tool.\n\n## Ignoring Scan Results\n\nIgnore rules can be added to ignore specific secret values, specific SHA512 values, specific paths, and specific Cycode secret and IaC rule IDs. This will cause the scan to not alert these values. The ignore rules are written and saved locally in the `./.cycode/config.yaml` file.\n\n> :warning: **Warning**<br/>\n> 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.\n\nThe following are the options available for the `cycode ignore` command:\n\n| Option | Description |\n|--------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `--by-value TEXT` | Ignore a specific value while scanning for secrets. See [Ignoring a Secret Value](#ignoring-a-secret-value) for more details. |\n| `--by-sha TEXT` | Ignore a specific SHA512 representation of a string while scanning for secrets. See [Ignoring a Secret SHA Value](#ignoring-a-secret-sha-value) for more details. |\n| `--by-path TEXT` | Avoid scanning a specific path. Need to specify scan type. See [Ignoring a Path](#ignoring-a-path) for more details. |\n| `--by-rule TEXT` | Ignore scanning a specific secret rule ID/IaC rule ID/SCA rule ID. See [Ignoring a Secret or Iac Rule](#ignoring-a-secret-iac-sca-or-sast-rule) for more details. |\n| `--by-package TEXT` | Ignore scanning a specific package version while running an SCA scan. Expected pattern - `name@version`. See [Ignoring a Package](#ignoring-a-package) for more details. |\n| `-t, --scan-type [secret\\|iac\\|sca\\|sast]` | Specify the scan you wish to execute (`secret`/`iac`/`sca`/`sast`), The default value is `secret` |\n| `-g, --global` | Add an ignore rule and update it in the global `.cycode` config file |\n\nIn the following example, a pre-commit scan runs and finds the following:\n\n```bash\n\u26d4 Found issue of type: generic-password (rule ID: ce3a4de0-9dfc-448b-a004-c538cf8b4710) in file: config/my_config.py\nSecret SHA: a44081db3296c84b82d12a35c446a3cba19411dddfa0380134c75f7b3973bff0 \u26d4\n0 | @@ -0,0 +1 @@\n1 | +my_password = 'h3l***********350'\n2 | \\ No newline at end of file\n```\n\nIf this is a value that is not a valid secret, then use the `cycode ignore` command to ignore the secret by its value, SHA value, specific path, or rule ID. If this is an IaC scan, then you can ignore that result by its path or rule ID.\n\n### Ignoring a Secret Value\n\nTo ignore a specific secret value, you will need to use the `--by-value` flag. This will ignore the given secret value from all future scans. Use the following command to add a secret value to be ignored:\n\n`cycode ignore --by-value {{secret-value}}`\n\nIn the example at the top of this section, the command to ignore a specific secret value is as follows:\n\n`cycode ignore --by-value h3110w0r1d!@#$350`\n\nIn the example above, replace the `h3110w0r1d!@#$350` value with your non-masked secret value. See the Cycode scan options for details on how to see secret values in the scan results.\n\n### Ignoring a Secret SHA Value\n\nTo ignore a specific secret SHA value, you will need to use the `--by-sha` flag. This will ignore the given secret SHA value from all future scans. Use the following command to add a secret SHA value to be ignored:\n\n`cycode ignore --by-sha {{secret-sha-value}}`\n\nIn the example at the top of this section, the command to ignore a specific secret SHA value is as follows:\n\n`cycode ignore --by-sha a44081db3296c84b82d12a35c446a3cba19411dddfa0380134c75f7b3973bff0`\n\nIn the example above, replace the `a44081db3296c84b82d12a35c446a3cba19411dddfa0380134c75f7b3973bff0` value with your secret SHA value.\n\n### Ignoring a Path\n\nTo ignore a specific path for either secret, IaC, or SCA scans, you will need to use the `--by-path` flag in conjunction with the `-t, --scan-type` flag (you must specify the scan type). This will ignore the given path from all future scans for the given scan type. Use the following command to add a path to be ignored:\n\n`cycode ignore -t {{scan-type}} --by-path {{path}}`\n\nOR\n\n`cycode ignore --scan-type {{scan-type}} --by-path {{path}}`\n\nIn the example at the top of this section, the command to ignore a specific path for a secret is as follows:\n\n`cycode ignore -t secret --by-path ~/home/my-repo/config`\n\nIn the example above, replace the `~/home/my-repo/config` value with your path value.\n\nIn the example at the top of this section, the command to ignore a specific path from IaC scans is as follows:\n\n`cycode ignore -t iac --by-path ~/home/my-repo/config`\n\nIn the example above, replace the `~/home/my-repo/config` value with your path value.\n\nIn the example at the top of this section, the command to ignore a specific path from SCA scans is as follows:\n\n`cycode ignore -t sca --by-path ~/home/my-repo/config`\n\nIn the example above, replace the `~/home/my-repo/config` value with your path value.\n\n### Ignoring a Secret, IaC, SCA, or SAST Rule\n\nTo ignore a specific secret, IaC, SCA, or SAST rule, you will need to use the `--by-rule` flag in conjunction with the `-t, --scan-type` flag (you must specify the scan type). This will ignore the given rule ID value from all future scans. Use the following command to add a rule ID value to be ignored:\n\n`cycode ignore -t {{scan-type}} --by-rule {{rule-ID}}`\n\nOR\n\n`cycode ignore --scan-type {{scan-type}} --by-rule {{rule-ID}}`\n\nIn the example at the top of this section, the command to ignore the specific secret rule ID is as follows:\n\n`cycode ignore --scan-type secret --by-rule ce3a4de0-9dfc-448b-a004-c538cf8b4710`\n\nIn the example above, replace the `ce3a4de0-9dfc-448b-a004-c538cf8b4710` value with the rule ID you want to ignore.\n\nIn the example at the top of this section, the command to ignore the specific IaC rule ID is as follows:\n\n`cycode ignore --scan-type iac --by-rule bdaa88e2-5e7c-46ff-ac2a-29721418c59c`\n\nIn the example above, replace the `bdaa88e2-5e7c-46ff-ac2a-29721418c59c` value with the rule ID you want to ignore.\n\nIn the example at the top of this section, the command to ignore the specific SCA rule ID is as follows:\n\n`cycode ignore --scan-type sca --by-rule dc21bc6b-9f4f-46fb-9f92-e4327ea03f6b`\n\nIn the example above, replace the `dc21bc6b-9f4f-46fb-9f92-e4327ea03f6b` value with the rule ID you want to ignore.\n\n### Ignoring a Package\n\n> [!NOTE]\n> This option is only available to the SCA scans.\n\nTo ignore a specific package in the SCA scans, you will need to use the `--by-package` flag in conjunction with the `-t, --scan-type` flag (you must specify the `sca` scan type). This will ignore the given package, using the `{{package_name}}@{{package_version}}` formatting, from all future scans. Use the following command to add a package and version to be ignored:\n\n`cycode ignore --scan-type sca --by-package {{package_name}}@{{package_version}}`\n\nOR\n\n`cycode ignore -t sca --by-package {{package_name}}@{{package_version}}`\n\nIn the example below, the command to ignore a specific SCA package is as follows:\n\n`cycode ignore --scan-type sca --by-package pyyaml@5.3.1`\n\nIn the example above, replace `pyyaml` with package name and `5.3.1` with the package version you want to ignore.\n\n### Ignoring using config file\n\nThe applied ignoring rules are stored in the configuration file called `config.yaml`.\nThis file could be easily shared between developers or even committed to remote Git.\nThese files are always located in the `.cycode` folder.\nThe folder starts with a dot (.), and you should enable the displaying of hidden files to see it.\n\n#### Path of the config files\n\nBy default, all `cycode ignore` commands save the ignoring rule to the current directory from which CLI has been run.\n\nExample: running ignoring CLI command from `/Users/name/projects/backend` will create `config.yaml` in `/Users/name/projects/backend/.cycode`\n\n```shell\n\u279c backend pwd\n/Users/name/projects/backend\n\u279c backend cycode ignore --by-value test-value\n\u279c backend tree -a\n.\n\u2514\u2500\u2500 .cycode\n \u2514\u2500\u2500 config.yaml\n\n2 directories, 1 file\n```\n\nThe second option is to save ignoring rules to the global configuration files.\nThe path of the global config is `~/.cycode/config.yaml`,\nwhere `~` means user\\`s home directory, for example, `/Users/name` on macOS.\n\nSaving to the global space could be performed with the `-g` flag of the `cycode ignore` command.\nFor example: `cycode ignore -g --by-value test-value`.\n\n#### Proper working directory\n\nThis is incredibly important to place the `.cycode` folder and run CLI from the same place.\nYou should double-check it when working with different environments like CI/CD (GitHub Actions, Jenkins, etc.).\n\nYou could commit the `.cycode` folder to the root of your repository.\nIn this scenario, you must run CLI scans from the repository root.\nIf it doesn't fit your requirements, you could temporarily copy the `.cycode` folder\nwherever you want and perform a CLI scan from this folder.\n\n#### Structure ignoring rules in the config\n\nIt's important to understand how CLI stores ignore rules to be able to read these configuration files or even modify them without CLI.\n\nThe abstract YAML structure:\n```yaml\nexclusions:\n *scanTypeName*:\n *ignoringType:\n - *ignoringValue1*\n - *ignoringValue2*\n```\n\nPossible values of `scanTypeName`: `iac`, `sca`, `sast`, `secret`.\nPossible values of `ignoringType`: `paths`, `values`, `rules`, `packages`, `shas`.\n\n> [!WARNING] \n> Values for \"ignore by value\" are not stored as plain text!\n> CLI stores sha256 hashes of the values instead.\n> You should put hashes of the string when modifying the configuration file by hand.\n\nExample of real `config.yaml`:\n```yaml\nexclusions:\n iac:\n rules:\n - bdaa88e2-5e7c-46ff-ac2a-29721418c59c\n sca:\n packages:\n - pyyaml@5.3.1\n secret:\n paths:\n - /Users/name/projects/build\n rules:\n - ce3a4de0-9dfc-448b-a004-c538cf8b4710\n shas:\n - a44081db3296c84b82d12a35c446a3cba19411dddfa0380134c75f7b3973bff0\n values:\n - a665a45920422f9d417e4867efdc4fb8a04a1f3fff1fa07e998e86f7f7a27ae3\n - 60303ae22b998861bce3b28f33eec1be758a213c86c93c076dbe9f558c11c752\n```\n\n# Report Command\n\n## Generating SBOM Report\n\nA software bill of materials (SBOM) is an inventory of all constituent components and software dependencies involved in the development and delivery of an application.\nUsing this command you can create an SBOM report for your local project or for your repository URI.\n\nThe following options are available for use with this command:\n\n| Option | Description | Required | Default |\n|----------------------------------------------------|--------------------------------|----------|-------------------------------------------------------|\n| `-f, --format [spdx-2.2\\|spdx-2.3\\|cyclonedx-1.4]` | SBOM format | Yes | | \n| `-o, --output-format [JSON]` | Specify the output file format | No | json |\n| `--output-file PATH` | Output file | No | autogenerated filename saved to the current directory |\n| `--include-vulnerabilities` | Include vulnerabilities | No | False |\n| `--include-dev-dependencies` | Include dev dependencies | No | False |\n\nThe following commands are available for use with this command:\n\n| Command | Description |\n|------------------|-----------------------------------------------------------------|\n| `path` | Generate SBOM report for provided path in the command |\n| `repository_url` | Generate SBOM report for provided repository URI in the command |\n\n### Repository\n\nTo create an SBOM report for a repository URI:\\\n`cycode report sbom --format <sbom format> --include-vulnerabilities --include-dev-dependencies --output-file </path/to/file> repository_url <repository url>`\n\nFor example:\\\n`cycode report sbom --format spdx-2.3 --include-vulnerabilities --include-dev-dependencies repository_url https://github.com/cycodehq/cycode-cli.git`\n\n### Local Project\n\nTo create an SBOM report for a path:\\\n`cycode report sbom --format <sbom format> --include-vulnerabilities --include-dev-dependencies --output-file </path/to/file> path </path/to/project>`\n\nFor example:\\\n`cycode report sbom --format spdx-2.3 --include-vulnerabilities --include-dev-dependencies path /path/to/local/project`\n\n# Syntax Help\n\nYou may add the `--help` argument to any command at any time to see a help message that will display available options and their syntax.\n\nTo see general help, simply enter the command:\n\n`cycode --help`\n\nTo see scan options, enter:\n\n`cycode scan --help`\n\nTo see the options available for a specific type of scan, enter:\n\n`cycode scan {{option}} --help`\n\nFor example, to see options available for a Path Scan, you would simply enter:\n\n`cycode scan path --help`\n\nTo see the options available for the ignore scan function, use this command:\n\n`cycode ignore --help`\n\nTo see the options available for report, use this command:\n\n`cycode report --help`\n\n\nTo see the options available for a specific type of report, enter:\n\n`cycode scan {{option}} --help`\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Boost security in your dev lifecycle via SAST, SCA, Secrets & IaC scanning.",
"version": "1.9.5",
"project_urls": {
"Homepage": "https://github.com/cycodehq/cycode-cli",
"Repository": "https://github.com/cycodehq/cycode-cli"
},
"split_keywords": [
"secret-scan",
" cycode",
" devops",
" token",
" secret",
" security",
" cycode",
" code"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e819bd6b23f5c7fbe5bcbdb2335ecb091f47eb6dea029cff677d8eccf45c0bb7",
"md5": "df0cac42ab7ac19b1970d60c629bdd0c",
"sha256": "66dc1667b1f5574006a506bc3f8d2ef3227bcf5b8bc01ecd752301788bafc8d5"
},
"downloads": -1,
"filename": "cycode-1.9.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "df0cac42ab7ac19b1970d60c629bdd0c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.7",
"size": 104338,
"upload_time": "2024-05-14T08:45:20",
"upload_time_iso_8601": "2024-05-14T08:45:20.133600Z",
"url": "https://files.pythonhosted.org/packages/e8/19/bd6b23f5c7fbe5bcbdb2335ecb091f47eb6dea029cff677d8eccf45c0bb7/cycode-1.9.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8385d4c6f2b8a97b2ae2eeb88091ec5c1d15245eac50843cfe1ab860edf6ca30",
"md5": "d8941dc532e4b354c24be75d57d5690e",
"sha256": "7e1f09e9f065010c1237a7b2627a35f042c62f1329611f22814cade77cf93687"
},
"downloads": -1,
"filename": "cycode-1.9.5.tar.gz",
"has_sig": false,
"md5_digest": "d8941dc532e4b354c24be75d57d5690e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.7",
"size": 81017,
"upload_time": "2024-05-14T08:45:22",
"upload_time_iso_8601": "2024-05-14T08:45:22.550460Z",
"url": "https://files.pythonhosted.org/packages/83/85/d4c6f2b8a97b2ae2eeb88091ec5c1d15245eac50843cfe1ab860edf6ca30/cycode-1.9.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-14 08:45:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "cycodehq",
"github_project": "cycode-cli",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "cycode"
}
JSON
