Skip to content

Commit

Permalink
docs(general): update docs about installation guidelines (#5352)
Browse files Browse the repository at this point in the history
* update docs about installation guidelines

* Update README.md

Co-authored-by: Taylor <[email protected]>

---------

Co-authored-by: Taylor <[email protected]>
  • Loading branch information
gruebel and tsmithv11 authored Jul 18, 2023
1 parent 77fe2cd commit 5760a69
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 43 deletions.
33 changes: 8 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,41 +70,18 @@ Scheduled scan result in Jenkins

### Installation

```sh
pip3 install checkov
```
To install pip follow the official [docs](https://pip.pypa.io/en/stable/cli/pip_install/)

Installation on Alpine:
```sh
pip3 install --upgrade pip && pip3 install --upgrade setuptools
pip3 install checkov
```

Installation on Ubuntu 18.04 LTS:

Ubuntu 18.04 ships with Python 3.6. Install python 3.7 (from ppa repository)

```sh
sudo apt update
sudo apt install software-properties-common
sudo add-apt-repository ppa:deadsnakes/ppa
sudo apt install python3.7
sudo apt install python3-pip
sudo python3.7 -m pip install -U checkov #to install or upgrade checkov)
```

or using [homebrew](https://formulae.brew.sh/formula/checkov) (macOS or Linux)
or with [Homebrew](https://formulae.brew.sh/formula/checkov) (macOS or Linux)

```sh
brew install checkov
```

or

```sh
brew upgrade checkov
```

### Enabling bash autocomplete
```sh
source <(register-python-argcomplete checkov)
Expand All @@ -116,6 +93,12 @@ if you installed checkov with pip3
pip3 install -U checkov
```

or with Homebrew

```sh
brew upgrade checkov
```

### Configure an input folder or file

```sh
Expand Down
26 changes: 8 additions & 18 deletions docs/2.Basics/Installing Checkov.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Installing Checkov is quick and straightforward—just install, configure input,
pip install checkov
```

### Install on Python
or

```shell
pip3 install checkov
Expand All @@ -28,26 +28,10 @@ pip3 install --upgrade pip && pip3 install --upgrade setuptools
pip3 install checkov
```

### Install on Ubuntu 18.04 LTS

Ubuntu 18.04 ships with Python 3.6. Before you can install Checkov, you need to install python 3.7 (from the PPA repository):

```shell
sudo apt update
sudo apt install software-properties-common
sudo add-apt-repository ppa:deadsnakes/ppa
sudo apt install python3.7
sudo apt install python3-pip
sudo python3.7 -m pip install -U checkov #to install or upgrade checkov)
```

or using homebrew (MacOS only)
### Install with Homebrew

```shell
brew install checkov
or

brew upgrade checkov
```

## Upgrading Checkov
Expand All @@ -58,6 +42,12 @@ If you installed Checkov with pip3, use the following command to upgrade:
pip3 install -U checkov
```

or with Homebrew

```sh
brew upgrade checkov
```

## Configure an input folder or file

### Configure a folder
Expand Down

0 comments on commit 5760a69

Please sign in to comment.