You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -55,27 +54,14 @@ ggshield" section of the "Getting started" page of ggshield public
55
54
documentation.
56
55
-->
57
56
58
-
## Requirements
59
-
60
-
`ggshield` works on macOS, Linux and Windows.
61
-
62
-
It requires **Python 3.8 or above** (except for standalone packages) and git.
63
-
64
-
⚠️ Python 3.8 is no longer supported by the Python Software Foundation since October, 14th 2024. GGShield will soon require Python 3.9 or above to run.
65
-
66
-
Some commands require additional programs:
67
-
68
-
- docker: to scan docker images.
69
-
- pip: to scan pypi packages.
70
-
71
57
## macOS
72
58
73
59
### Homebrew
74
60
75
61
You can install `ggshield` using Homebrew:
76
62
77
63
```shell
78
-
$ brew install gitguardian/tap/ggshield
64
+
$ brew install ggshield
79
65
```
80
66
81
67
Upgrading is handled by Homebrew.
@@ -113,6 +99,10 @@ This archive _does not_ require installing Python, but you have to manually down
113
99
114
100
`ggshield` can be installed on all supported operating systems via its [PyPI package](https://pypi.org/project/ggshield).
115
101
102
+
It requires **a supported version of Python (not EOL)** (except for standalone packages) and git.
103
+
104
+
If you don't use our packaged versions of `ggshield`, please be aware that we follow the [Python release cycle](https://devguide.python.org/versions/) and do not support versions that have reached EOL.
105
+
116
106
### Using pipx
117
107
118
108
The recommended way to install `ggshield` from PyPI is to use [pipx](https://pypa.github.io/pipx/), which will install it in an isolated environment:
@@ -161,8 +151,8 @@ You can now use `ggshield` to search for secrets:
161
151
162
152
- in files: `ggshield secret scan path -r .`
163
153
- in repositories: `ggshield secret scan repo .`
164
-
- in Docker images: `ggshield secret scan docker ubuntu:22.04`
165
-
- in Pypi packages: `ggshield secret scan pypi flask`
154
+
- in Docker images (`docker` command must be available): `ggshield secret scan docker ubuntu:22.04`
155
+
- in Pypi packages (`pip` command must be available): `ggshield secret scan pypi flask`
166
156
- and more, have a look at `ggshield secret scan --help` output for details.
0 commit comments