gitguardian/ggshieldDetecte 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.
[!IMPORTANT] macOS: a atualização para a versão 1.54.0 aciona um prompt do Keychain para
ggshield-py, um segundo binário que agora lê seu token salvo como parte das nossas melhorias de desempenho. Clique em Always Allow (Sempre Permitir); ele não perguntará novamente.
ggshield é uma aplicação CLI que é executada no 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 possíveis vulnerabilidades em arquivos e outros conteúdos de texto.
Apenas metadados como horário da chamada, tamanho da requisição e modo de escaneamento são armazenados dos escaneamentos usando ggshield, portanto os segredos não serão exibidos no seu dashboard e seus arquivos e segredos não serão armazenados.
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.
Consulte 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.
Você pode instalar o ggshield usando o Homebrew:
brew install ggshield
A atualização é gerenciada pelo Homebrew.
Alternativamente, você pode baixar e instalar um pacote .pkg autônomo da página de releases do ggshield.
Este pacote não requer a instalação do Python, mas você precisa baixar manualmente as novas versões.
Pacotes Deb e RPM estão disponíveis no Cloudsmith.
Instruções de configuração:
A atualização é gerenciada pelo gerenciador de pacotes.
ggshield está disponível através do gerenciador de pacotes Chocolatey:
choco install ggshield
Baixe o instalador MSI da página de releases do ggshield e instale-o:
msiexec /i ggshield-VERSION-x86_64-pc-windows-msvc.msi
Fornecemos um arquivo .zip autônomo na página de releases 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 a instalação do Python, mas você precisa baixar manualmente as novas versões.
ggshield pode ser instalado em todos os sistemas operacionais suportados através do seu pacote PyPI.
Ele requer uma versão suportada do Python (não EOL) (exceto para pacotes autônomos) e git.
Se você não usa nossas versões empacotadas do ggshield, esteja ciente de que seguimos o ciclo de lançamento do Python e não oferecemos suporte a versões que atingiram o EOL.
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
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 estiver 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
ggshield auth loginPara usar o ggshield você precisa se autenticar nos servidores do GitGuardian. Para 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 saber mais sobre isso na documentação do ggshield auth login.