Skip to content

Commit

Permalink
Merge pull request #713 from GitGuardian/cgarcia/-/update-readme
Browse files Browse the repository at this point in the history
docs(readme): update installation instructions
  • Loading branch information
agateau-gg authored Aug 23, 2023
2 parents f14871f + 1dfd803 commit 136eb5e
Showing 1 changed file with 19 additions and 5 deletions.
24 changes: 19 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Only metadata such as call time, request size and scan mode is stored from scans
- [Installation](#installation)
- [macOS - Using Homebrew](#macos---using-homebrew)
- [Linux packages](#linux-packages)
- [Other Operating Systems - Using pip](#other-operating-systems---using-pip)
- [Other Operating Systems - Using pipx or pip](#other-operating-systems---using-pipx-or-pip)
- [Installing](#installing)
- [Updating](#updating)
- [Initial setup](#initial-setup)
Expand Down Expand Up @@ -59,12 +59,20 @@ Setup instructions:
- [Deb packages](https://cloudsmith.io/~gitguardian/repos/ggshield/setup/#formats-deb)
- [RPM packages](https://cloudsmith.io/~gitguardian/repos/ggshield/setup/#formats-rpm)

## Other Operating Systems - Using pip
## Other Operating Systems - Using pipx or pip

### Installing

The recommended way to install `ggshield` is to use [pipx](https://pypa.github.io/pipx/), which will install it an isolated environment:

```shell
$ pipx install ggshield
```

Alternatively, you can install with pip as a user package. This will not work if your Python installation is declared as externally managed (for example when using the system Python on operating systems like Debian 12):

```shell
$ pip install ggshield
$ pip install --user -U ggshield
```

`ggshield` supports **Python 3.8 and newer**.
Expand All @@ -73,10 +81,16 @@ The package should run on MacOS, Linux and Windows.

### Updating

To update `ggshield` you can add the option `-U/--upgrade` to the pip install command.
To update `ggshield` when installed with pipx:

```shell
$ pipx upgrade ggshield
```

If you installed `ggshield` with pip, you can add the option `-U/--upgrade` to the pip install command to update:

```shell
$ pip install -U ggshield
$ pip install --user -U ggshield
```

# Initial setup
Expand Down

0 comments on commit 136eb5e

Please sign in to comment.