cycode 3.1.1.dev1__tar.gz → 3.1.1.dev2__tar.gz

{cycode-3.1.1.dev1 → cycode-3.1.1.dev2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cycode
-Version: 3.1.1.dev1
+Version: 3.1.1.dev2
 Summary: Boost security in your dev lifecycle via SAST, SCA, Secrets & IaC scanning.
 Home-page: https://github.com/cycodehq/cycode-cli
 License: MIT
@@ -91,7 +91,8 @@ This guide walks you through both installation and usage.
         6. [Ignoring via a config file](#ignoring-via-a-config-file)
 5. [Report command](#report-command)
     1. [Generating SBOM Report](#generating-sbom-report)
-6. [Syntax Help](#syntax-help)
+6. [Scan logs](#scan-logs)
+7. [Syntax Help](#syntax-help)
 
 # Prerequisites
 
@@ -332,20 +333,20 @@ The following are the options and commands available with the Cycode CLI applica
 
 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`.                                                                                                                                                            |
-| `--client-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.                                                                                                                                                                                                  |
-| `--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). |
-| `--cycode-report`                                          | When specified, displays a link to the scan report in the Cycode platform in the console output.                                                                                                                                                        |
-| `--no-restore`                                             | When specified, Cycode will not run restore command. Will scan direct dependencies ONLY!                                                                                                                                                                |
-| `--gradle-all-sub-projects`                                | When specified, Cycode will run gradle restore command for all sub projects. Should run from root project directory ONLY!                                                                                                                               |
-| `--help`                                                   | Show options for given command.                                                                                                                                                                                                                         |
+| Option                                                     | Description                                                                                                               |
+|------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------|
+| `-t, --scan-type [secret\|iac\|sca\|sast]`                 | Specify the scan you wish to execute (`secret`/`iac`/`sca`/`sast`), the default is `secret`.                              |
+| `--client-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.                                                                    |
+| `--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 Cycode.                                                              |
+| `--cycode-report`                                          | When specified, displays a link to the scan report in the Cycode platform in the console output.                          |
+| `--no-restore`                                             | When specified, Cycode will not run restore command. Will scan direct dependencies ONLY!                                  |
+| `--gradle-all-sub-projects`                                | When specified, Cycode will run gradle restore command for all sub projects. Should run from root project directory ONLY! |
+| `--help`                                                   | Show options for given command.                                                                                           |
 
 | Command                                | Description                                                     |
 |----------------------------------------|-----------------------------------------------------------------|
@@ -369,16 +370,14 @@ The following command will scan the repository for policy violations that have s
 > [!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.
+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.
 
 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`
 
-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).
+When using this option, the scan results will appear in Cycode.
 
-> [!WARNING]
-> You must be an `owner` or an `admin` in Cycode to view the knowledge graph page.
 
 #### Cycode Report Option
 
@@ -879,6 +878,10 @@ To create an SBOM report for a path:\
 For example:\
 `cycode report sbom --format spdx-2.3 --include-vulnerabilities --include-dev-dependencies path /path/to/local/project`
 
+# Scan Logs
+
+All CLI scan are logged in Cycode.  The logs can be found under Settings > CLI Logs.
+
 # 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.

{cycode-3.1.1.dev1 → cycode-3.1.1.dev2}/README.md

@@ -50,7 +50,8 @@ This guide walks you through both installation and usage.
         6. [Ignoring via a config file](#ignoring-via-a-config-file)
 5. [Report command](#report-command)
     1. [Generating SBOM Report](#generating-sbom-report)
-6. [Syntax Help](#syntax-help)
+6. [Scan logs](#scan-logs)
+7. [Syntax Help](#syntax-help)
 
 # Prerequisites
 
@@ -291,20 +292,20 @@ The following are the options and commands available with the Cycode CLI applica
 
 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`.                                                                                                                                                            |
-| `--client-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.                                                                                                                                                                                                  |
-| `--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). |
-| `--cycode-report`                                          | When specified, displays a link to the scan report in the Cycode platform in the console output.                                                                                                                                                        |
-| `--no-restore`                                             | When specified, Cycode will not run restore command. Will scan direct dependencies ONLY!                                                                                                                                                                |
-| `--gradle-all-sub-projects`                                | When specified, Cycode will run gradle restore command for all sub projects. Should run from root project directory ONLY!                                                                                                                               |
-| `--help`                                                   | Show options for given command.                                                                                                                                                                                                                         |
+| Option                                                     | Description                                                                                                               |
+|------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------|
+| `-t, --scan-type [secret\|iac\|sca\|sast]`                 | Specify the scan you wish to execute (`secret`/`iac`/`sca`/`sast`), the default is `secret`.                              |
+| `--client-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.                                                                    |
+| `--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 Cycode.                                                              |
+| `--cycode-report`                                          | When specified, displays a link to the scan report in the Cycode platform in the console output.                          |
+| `--no-restore`                                             | When specified, Cycode will not run restore command. Will scan direct dependencies ONLY!                                  |
+| `--gradle-all-sub-projects`                                | When specified, Cycode will run gradle restore command for all sub projects. Should run from root project directory ONLY! |
+| `--help`                                                   | Show options for given command.                                                                                           |
 
 | Command                                | Description                                                     |
 |----------------------------------------|-----------------------------------------------------------------|
@@ -328,16 +329,14 @@ The following command will scan the repository for policy violations that have s
 > [!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.
+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.
 
 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`
 
-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).
+When using this option, the scan results will appear in Cycode.
 
-> [!WARNING]
-> You must be an `owner` or an `admin` in Cycode to view the knowledge graph page.
 
 #### Cycode Report Option
 
@@ -838,6 +837,10 @@ To create an SBOM report for a path:\
 For example:\
 `cycode report sbom --format spdx-2.3 --include-vulnerabilities --include-dev-dependencies path /path/to/local/project`
 
+# Scan Logs
+
+All CLI scan are logged in Cycode.  The logs can be found under Settings > CLI Logs.
+
 # 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.

cycode-3.1.1.dev2/cycode/__init__.py

@@ -0,0 +1 @@
+__version__ = '3.1.1.dev2'  # DON'T TOUCH. Placeholder. Will be filled automatically on poetry build from Git Tag

{cycode-3.1.1.dev1 → cycode-3.1.1.dev2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "cycode"
-version = "3.1.1.dev1" # DON'T TOUCH. Placeholder. Will be filled automatically on poetry build from Git Tag
+version = "3.1.1.dev2" # DON'T TOUCH. Placeholder. Will be filled automatically on poetry build from Git Tag
 description = "Boost security in your dev lifecycle via SAST, SCA, Secrets & IaC scanning."
 keywords=["secret-scan", "cycode", "devops", "token", "secret", "security", "cycode", "code"]
 authors = ["Cycode <support@cycode.com>"]

cycode-3.1.1.dev1/cycode/__init__.py

@@ -1 +0,0 @@
-__version__ = '3.1.1.dev1'  # DON'T TOUCH. Placeholder. Will be filled automatically on poetry build from Git Tag