Skip to content

Commit 09aa709

Browse files
authored
Update README for release; CM-23013 - fix image links (#113)
1 parent 5ca59e9 commit 09aa709

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

README.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ This guide will guide you through both installation and usage.
4646

4747
# Prerequisites
4848

49-
- The Cycode CLI application requires Python version 3.8 or later.
49+
- The Cycode CLI application requires Python version 3.7 or later.
5050
- Use the [`cycode auth` command](#use-auth-command) to authenticate to Cycode with the CLI
5151
- Alternatively, a Cycode Client ID and Client Secret Key can be acquired using the steps from 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 for details on obtaining these values.
5252

@@ -86,24 +86,24 @@ To install the Cycode CLI application on your local machine, perform the followi
8686

8787
2. A browser window will appear, asking you to log into Cycode (as seen below):
8888

89-
![](./images/cycode_login.png)
89+
![Cycode login](https://raw.githubusercontent.com/cycodehq-public/cycode-cli/main/images/cycode_login.png)
9090

9191
3. Enter you login credentials on this page and log in.
9292

9393
4. You will eventually be taken to this page, where you will be asked to choose the business group you want to authorize Cycode with (if applicable):
9494

95-
![](./images/authorize_cli.png)
95+
![authorize CLI](https://raw.githubusercontent.com/cycodehq-public/cycode-cli/main/images/authorize_cli.png)
9696

9797
> :memo: **Note**<br/>
9898
> This will be the default method for authenticating with the Cycode CLI.
9999
100100
5. Click the **Allow** button to authorize the Cycode CLI on the chosen business group.
101101

102-
![](./images/allow_cli.png)
102+
![allow CLI](https://raw.githubusercontent.com/cycodehq-public/cycode-cli/main/images/allow_cli.png)
103103

104104
6. Once done, you will see the following screen, if it was successfully selected:
105105

106-
![](./images/successfully_auth.png)
106+
![successfully auth](https://raw.githubusercontent.com/cycodehq-public/cycode-cli/main/images/successfully_auth.png)
107107

108108
7. In the terminal/command line screen, you will see the following when exiting the browser window:
109109

@@ -160,19 +160,19 @@ export CYCODE_CLIENT_SECRET={your Cycode Secret Key}
160160

161161
1. From the Control Panel, navigate to the System menu:
162162

163-
![](./images/image1.png)
163+
![](https://raw.githubusercontent.com/cycodehq-public/cycode-cli/main/images/image1.png)
164164

165165
2. Next, click Advanced system settings:
166166

167-
![](./images/image2.png)
167+
![](https://raw.githubusercontent.com/cycodehq-public/cycode-cli/main/images/image2.png)
168168

169169
3. In the System Properties window that opens, click the Environment Variables button:
170170

171-
![](./images/image3.png)
171+
![](https://raw.githubusercontent.com/cycodehq-public/cycode-cli/main/images/image3.png)
172172

173173
4. Create `CYCODE_CLIENT_ID` and `CYCODE_CLIENT_SECRET` variables with values matching your ID and Secret Key, respectively:
174174

175-
![](./images/image4.png)
175+
![](https://raw.githubusercontent.com/cycodehq-public/cycode-cli/main/images/image4.png)
176176

177177
## Install Pre-Commit Hook
178178

@@ -191,7 +191,7 @@ Perform the following steps to install the pre-commit hook:
191191
```yaml
192192
repos:
193193
- repo: https://github.com/cycodehq-public/cycode-cli
194-
rev: 0.2.3
194+
rev: stable
195195
hooks:
196196
- id: cycode
197197
language_version: python3
@@ -211,11 +211,12 @@ repos:
211211

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

214-
| Option | Description |
215-
|-------------------|-----------------------------|
216-
| `-v`, `--verbose` | Show detailed logs |
217-
| `--version` | Show the version and exit. |
218-
| `--help` | Show options for given command. |
214+
| Option | Description |
215+
|-------------------------|-----------------------------------------------------------|
216+
| `--output [text\|json]` | Specify the output (`text`/`json`). The default is `text` |
217+
| `-v`, `--verbose` | Show detailed logs |
218+
| `--version` | Show the version and exit. |
219+
| `--help` | Show options for given command. |
219220

220221
| Command | Description |
221222
|-------------------------------------|-------------|
@@ -235,7 +236,6 @@ The Cycode CLI application offers several types of scans so that you can choose
235236
| `--client-id TEXT` | Specify a Cycode client ID for this specific scan execution |
236237
| `--show-secret BOOLEAN` | Show secrets in plain text. See [Show/Hide Secrets](#showhide-secrets) section for more details. |
237238
| `--soft-fail BOOLEAN` | Run scan without failing, always return a non-error status code. See [Soft Fail](#soft-fail) section for more details. |
238-
| `--output [text\|json]` | Specify the results output (`text`/`json`). The default is `text` |
239239
| `--severity-threshold [INFO\|LOW\|MEDIUM\|HIGH\|CRITICAL]` | Show only violations at the specified level or higher (supported for the SCA scan type only). |
240240
| `--sca-scan` | Specify the SCA scan you wish to execute (`package-vulnerabilities`/`license-compliance`). The default is both |
241241
| `--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). |
@@ -360,7 +360,7 @@ Report URL: https://app.cycode.com/on-demand-scans/617ecc3d-9ff2-493e-8be8-2c1fe
360360
361361
The report page will look something like below:
362362
363-
![](./images/scan_details.png)
363+
![](https://raw.githubusercontent.com/cycodehq-public/cycode-cli/main/images/scan_details.png)
364364
365365
## Package Vulnerabilities Option
366366
@@ -698,4 +698,4 @@ For example, to see options available for a Path Scan, you would simply enter:
698698
699699
To see the options available for the ignore scan function, use this command:
700700
701-
`cycode ignore --help`
701+
`cycode ignore --help`

0 commit comments

Comments
 (0)