ggshield v1.53.0
Detecte e valide mais de 500 tipos de segredos codificados com verificações avançadas. Use-o como hook de pré-commit, GitHub Action ou CLI para detecção proativa de segredos e segurança.
ggshield: proteja seu código com GitGuardian
ggshield é um aplicativo CLI que roda em seu ambiente local ou em um ambiente de CI para ajudá-lo a detectar mais de 500 tipos de segredos.
ggshield usa nossa API pública através do py-gitguardian para escanear e detectar potenciais vulnerabilidades em arquivos e outros conteúdos de texto.
Apenas metadados como tempo de chamada, tamanho da solicitação e modo de varredura são armazenados a partir de varreduras usando ggshield, portanto, os segredos não serão exibidos no seu painel e seus arquivos e segredos não serão armazenados.
Índice
- Instalação
- Configuração inicial
- Primeiros passos
- Integrações
- Saiba mais
- Saída
- Projetos open source relacionados
- Licença
Instalação
Script de instalação (Recomendado)
A maneira mais rápida de instalar o ggshield.
Linux / macOS:
curl -sSfL \
https://raw.githubusercontent.com/GitGuardian/ggshield/main/scripts/install/install.sh | bash
Windows (PowerShell):
irm https://raw.githubusercontent.com/GitGuardian/ggshield/main/scripts/install/install.ps1 | iex
Ou, se você preferir curl (incluído no Windows 10+):
curl.exe -sSL https://raw.githubusercontent.com/GitGuardian/ggshield/main/scripts/install/install.ps1 | powershell -NoProfile -ExecutionPolicy Bypass -Command -
O script aceita opções como --instance e --plugin (instalar um plugin). Para o workspace da UE ou uma instância auto-hospedada, defina a variável de ambiente GITGUARDIAN_INSTANCE (ou passe --instance <URL>) antes de executar.
Veja scripts/install/README.md para a lista completa de opções, os outros métodos de instalação e como desinstalar.
Os métodos abaixo instalam a CLI manualmente.
macOS
Homebrew
Você pode instalar o ggshield usando Homebrew:
brew install ggshield
A atualização é gerenciada pelo Homebrew.
Pacote .pkg independente
Alternativamente, você pode baixar e instalar um pacote .pkg independente da página de lançamentos do ggshield.
Este pacote não requer instalação do Python, mas você precisa baixar manualmente novas versões.
Linux
Pacotes Deb e RPM
Pacotes Deb e RPM estão disponíveis no Cloudsmith.
Instruções de configuração:
A atualização é gerenciada pelo gerenciador de pacotes.
Windows
Chocolatey
ggshield está disponível através do gerenciador de pacotes Chocolatey:
choco install ggshield
Instalador MSI
Baixe o instalador MSI da página de lançamentos do ggshield e instale-o:
msiexec /i ggshield-VERSION-x86_64-pc-windows-msvc.msi
Arquivo .zip independente
Fornecemos um arquivo .zip independente na página de lançamentos do ggshield.
Descompacte o arquivo no seu disco e adicione o diretório que contém o arquivo ggshield.exe ao %PATH%.
Este arquivo não requer instalação do Python, mas você precisa baixar manualmente novas versões.
Todos os sistemas operacionais
ggshield pode ser instalado em todos os sistemas operacionais suportados através do seu pacote PyPI.
Requer uma versão suportada do Python (não EOL) (exceto para pacotes independentes) e git.
Se você não usar nossas versões empacotadas do ggshield, esteja ciente de que seguimos o ciclo de lançamento do Python e não suportamos versões que atingiram o fim da vida (EOL).
Usando pipx
A maneira recomendada de instalar o ggshield a partir do PyPI é usar o pipx, que o instalará em um ambiente isolado:
pipx install ggshield
Para atualizar sua instalação, execute:
pipx upgrade ggshield
Usando pip
Você também pode instalar o ggshield a partir do PyPI usando pip, mas isso não é recomendado porque a instalação não é isolada, então outros aplicativos ou pacotes instalados dessa forma podem afetar sua instalação do ggshield. Este método também não funcionará se sua instalação do Python for declarada como gerenciada externamente (por exemplo, ao usar o Python do sistema em sistemas operacionais como Debian 12):
pip install --user ggshield
Para atualizar sua instalação, execute:
pip install --user --upgrade ggshield
Configuração inicial
Usando ggshield auth login
Para usar o ggshield, você precisa se autenticar nos servidores do GitGuardian. Para fazer isso, use o comando ggshield auth login. Este comando automatiza o provisionamento de um token de acesso pessoal e sua configuração na estação de trabalho local.
Você pode aprender mais sobre isso na documentação do ggshield auth login.