[!NOTE] Venha se juntar a nós na SafetyCLI. Estamos contratando para várias funções.

Tabela de Conteúdo

• Tabela de Conteúdo
• Introdução
• Principais Recursos
• Começando
  • GitHub Action
  • Interface de Linha de Comando
    • 1. Instalação
    • 2. Faça Login ou Cadastre-se
    • 3. Executando Sua Primeira Varredura
  • Comandos Básicos
• Acordo de Nível de Serviço (SLA)
• Documentação Detalhada
• Licença
• Versões Python Suportadas
• Recursos

Introdução

O Safety CLI é um scanner de vulnerabilidades de dependências Python projetado para melhorar a segurança da cadeia de suprimentos de software, detectando pacotes com vulnerabilidades conhecidas e pacotes maliciosos em ambientes de desenvolvimento local, CI/CD e sistemas de produção. O Safety CLI pode ser implantado em minutos e fornece recomendações claras e acionáveis para correção de vulnerabilidades detectadas.

Aproveitando o banco de dados mais abrangente do setor de vulnerabilidades e pacotes maliciosos, o Safety CLI Scanner permite que as equipes detectem vulnerabilidades em todas as etapas do ciclo de vida de desenvolvimento de software.

Principais Recursos

• Varredura de segurança de dependências versátil e abrangente para pacotes Python.
• Utiliza o Safety DB, o banco de dados de vulnerabilidades mais abrangente disponível para Python.
• Saída clara com recomendações detalhadas para correção de vulnerabilidades.
• Atualiza automaticamente arquivos de requisitos para versões seguras de dependências quando disponíveis, guiado pelas configurações de política do seu projeto.
• Varredura de arquivos de requisitos individuais e diretórios de projeto ou varreduras em todo o sistema em máquinas de desenvolvimento, pipelines CI/CD e sistemas de Produção para detectar dependências vulneráveis ou maliciosas.
• Saída em JSON, SBOM, HTML e texto.
• Fácil integração com pipelines CI/CD, incluindo GitHub Actions.
• Pronto para Empresas: O Safety CLI pode ser implantado em grandes equipes com configurações de projeto complexas com facilidade, no local ou como produto SaaS.

Começando

GitHub Action

• Teste o Safety CLI em CI/CD usando nossa GitHub Action.
• Documentação completa sobre a GitHub Action está disponível em nosso Hub de Documentação.

Interface de Linha de Comando

1. Instalação

• Instale o Safety em sua máquina de desenvolvimento.
• Execute pip install safety.

2. Faça Login ou Cadastre-se

• Execute sua primeira varredura usando safety scan.
• Se não estiver autenticado, o Safety solicitará a criação de conta ou login.
• Use safety auth para verificar o status de autenticação.

3. Executando Sua Primeira Varredura

• Navegue até um diretório de projeto e execute safety scan.
• O Safety realizará uma varredura e apresentará os resultados no Terminal.

Comandos Básicos

• safety --help: Acesse a ajuda e exiba todos os comandos disponíveis.
• safety auth: Inicie o fluxo de autenticação ou exiba o status.
• safety scan: Execute uma varredura de vulnerabilidades no diretório atual.
• safety system-scan: Descubra ativos da cadeia de suprimentos em sua máquina de desenvolvimento — assistentes de IA (ex.: Claude Code, Claude Desktop), dependências, runtimes, ambientes e ferramentas de desenvolvimento. Disponível como parte do produto comercial Safety — veja https://getsafety.com/.
• safety scan --apply-fixes: Atualize dependências vulneráveis.

Acordo de Nível de Serviço (SLA)

Estamos comprometidos em manter um alto nível de capacidade de resposta e transparência no gerenciamento de problemas relatados em nossos repositórios. Este SLA descreve nossas políticas e procedimentos para lidar com problemas, garantindo resoluções oportunas e comunicação eficaz com nossa comunidade.

• Leia nosso SLA completo

Documentação Detalhada

A documentação completa está disponível em https://docs.safetycli.com.

Incluídos na documentação estão os seguintes tópicos principais:

Safety CLI 3

• Introdução ao Safety CLI 3
• Guia de Início Rápido
• Instalação e Autenticação
• Varredura de Pacotes Vulneráveis e Maliciosos
• Visualização de Resultados de Varredura
• Comandos e Entradas Disponíveis
• Varredura em CI/CD
• Varredura de Licenças
• Códigos de Saída

Correção de Vulnerabilidades

• Aplicando Correções

Integração

• Protegendo Repositórios Git
• GitHub
• GitHub Actions
• GitLab
• Hooks Pós-Commit do Git
• BitBucket
• Pipenv
• Contêineres Docker

Administração

• Gerenciamento de Políticas

Saída

• Opções de Saída e Recomendações
• Saída JSON
• Saída SBOM
• Saída HTML

Diversos

• Notas de Versão
• Mudanças Significativas no Safety 3
• Documentação do Safety 2.x
• Suporte

O status do sistema está disponível em https://status.safetycli.com