Skip to content

Commit

Permalink
CM-28230 - Update GitHub organization name (#176)
Browse files Browse the repository at this point in the history
  • Loading branch information
MarshalX authored Nov 6, 2023
1 parent ebbca2c commit aa72f50
Show file tree
Hide file tree
Showing 4 changed files with 105 additions and 106 deletions.
2 changes: 1 addition & 1 deletion LICENCE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2022 cycodehq-public
Copyright (c) 2022 Cycode Ltd.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
25 changes: 12 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,24 +91,24 @@ To install the Cycode CLI application on your local machine, perform the followi

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

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

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):

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

> :memo: **Note**<br/>
> 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.

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

6. Once completed, you'll see the following screen, if it was selected successfully:

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

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

Expand Down Expand Up @@ -177,19 +177,19 @@ export CYCODE_CLIENT_SECRET={your Cycode Secret Key}

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

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

2. Next, click Advanced system settings:

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

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

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

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

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

5. Insert the cycode.exe into the path to complete the installation.

Expand All @@ -209,11 +209,10 @@ Perform the following steps to install the pre-commit hook:

```yaml
repos:
- repo: https://github.com/cycodehq-public/cycode-cli
rev: stable
- repo: https://github.com/cycodehq/cycode-cli
rev: v1.4.0
hooks:
- id: cycode
language_version: python3
stages:
- commit
```
Expand Down Expand Up @@ -383,7 +382,7 @@ Report URL: https://app.cycode.com/on-demand-scans/617ecc3d-9ff2-493e-8be8-2c1fe
The report page will look something like below:
![](https://raw.githubusercontent.com/cycodehq-public/cycode-cli/main/images/scan_details.png)
![](https://raw.githubusercontent.com/cycodehq/cycode-cli/main/images/scan_details.png)
### Package Vulnerabilities Option
Expand Down Expand Up @@ -758,7 +757,7 @@ 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-public/cycode-cli.git`
`cycode report sbom --format spdx-2.3 --include-vulnerabilities --include-dev-dependencies repository_url https://github.com/cycodehq/cycode-cli.git`
### Local Project
Expand Down
Loading

0 comments on commit aa72f50

Please sign in to comment.