Skip to content

Commit c637108

Browse files
committed
update readme
1 parent 3e0d5b1 commit c637108

1 file changed

Lines changed: 13 additions & 0 deletions

File tree

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,19 @@ A CLI tool for adding Contrast Integrations via rule customizations.
33

44
Adapted from [Contrast-Security-OSS/integrations-scw](https://github.com/Contrast-Security-OSS/integrations-scw) to include a CLI tool, and also to include Secure Flag, Secure Code Warrior and possibly other integrations in the future.
55

6+
## Installation
7+
The quickest and easiest way to get started would be to install the CLI tool using pipx directly from the latest GitHub release:
8+
```sh
9+
pipx install https://github.com/Contrast-Security-OSS/contrast-integrations-cli/releases/download/v2.0.0/contrast_integrations_cli-2.0.0-py3-none-any.whl
10+
11+
contrast-integrations --help
12+
```
13+
14+
Or clone this repo and run the CLI tool with Poetry
15+
* `poetry install` to install dependencies
16+
* `poetry run contrast-integrations --help` to run the CLI tool
17+
* `poetry build` to build a wheel file
18+
619
## Usage
720
```sh
821
contrast-integrations --help

0 commit comments

Comments
 (0)