
preflight v0.20.1
Ferramenta CLI baseada em Go que verifica bases de código quanto à prontidão para lançamento, detectando configuração ausente, problemas de higiene de segurança, vazamentos de segredos e lacunas de integração antes da implantação em produção.
Preflight.sh
Preflight.sh é uma ferramenta de linha de comando que verifica seu código em busca de prontidão para lançamento. Identifica configurações ausentes, problemas de integração, preocupações de segurança, lacunas de metadados de SEO e outros erros comuns antes de você implantar em produção.
Não passe vergonha em produção. Basta executar o comando.
Instalação
Homebrew (macOS/Linux)
brew install preflightsh/preflight/preflight
npm
npm install -g @preflightsh/preflight
Go
go install github.com/preflightsh/preflight@latest
Docker
docker pull ghcr.io/preflightsh/preflight
Script de Shell
curl -fsSL https://preflight.sh/install.sh | sh
Download Manual
Baixe a versão mais recente em GitHub Releases.
A partir da v0.23.0, cada arquivo inclui proveniência de build assinada. Para verificar se um download foi gerado pelo workflow de release deste repositório:
gh attestation verify preflight_<version>_<os>_<arch>.tar.gz --repo preflightsh/preflight
Início Rápido
# Initialize in your project directory
cd your-project
preflight init
# (asks before replacing an existing preflight.yml; --force skips the question)
# In a script or CI job, where nobody can answer, pass --yes to accept the
# detected defaults. Without it, init stops and writes nothing when its input
# ends before the questions do.
# Run all checks
preflight scan
# Scan a specific directory
preflight scan /path/to/project
# Run with verbose output (shows which files matched each check)
preflight scan --verbose
preflight scan -v # short form
# Run in CI mode with JSON output
preflight scan --ci --format json
# Run only specific checks, or skip some, for fast iteration
# (one-off; unlike `preflight ignore` it doesn't change preflight.yml)
preflight scan --only seo_meta,og_twitter
preflight scan --skip vulnerability,secrets
# Silence a check
preflight ignore sitemap
# Unsilence a check
preflight unignore sitemap
# List all check IDs
preflight checks
Agent Skill
Este repositório inclui uma agent skill compatível com skills.sh em skills/preflight/SKILL.md. Ela fornece aos agentes de codificação um fluxo de trabalho Preflight repetível: inspecionar preflight.yml, executar varreduras seguras para CI, triar os achados, evitar ignores inseguros, executar novamente a validação e relatar o risco residual de lançamento.
Liste a skill deste repositório:
# With Bun
bunx --yes skills add preflightsh/preflight --list
# Or with npm
npx --yes skills add preflightsh/preflight --list
Instale apenas a skill Preflight:
# With Bun
bunx --yes skills add preflightsh/preflight --skill preflight
# Or with npm
npx --yes skills add preflightsh/preflight --skill preflight
Painel e Sugestões de IA
O Preflight é totalmente utilizável a partir da linha de comandos sem qualquer conta. O painel opcional em app.preflight.sh acrescenta um histórico alojado das suas análises e sugestões de correção geradas por IA para cada constatação. O seu código nunca sai da sua máquina: a análise é executada localmente e nada é enviado a menos que publique. Os tokens bearer do painel estão restritos à origem que os emitiu, e os redirecionamentos autenticados não podem atravessar origens nem fazer downgrade de HTTPS.
O que o publicar envia
- O ID, título, estado (aprovado, ignorado, inconclusivo, gravidade) de cada verificação e as contagens de resumo.
- A mensagem real para as verificações cujas mensagens são construídas a partir de texto fixo, contagens, caminhos relativos ao repositório, nomes DNS ou conteúdo de páginas públicas: as verificações de SEO e sociais,
security_headers,ssl,www_redirect,email_auth,debug_statements,error_pages,image_optimization,legal_pagese as verificações de ficheiros de normas web.debug_statementseimage_optimizationincluem até cinco constatações (ficheiro e linha, ou ficheiro e tamanho). - Antes do envio, essas mensagens são depuradas: os URLs de staging e produção configurados são reduzidos às suas origens, e a chave IndexNow, o URL do webhook Stripe, o caminho do layout
seoMetae os nomes dos ficheiros env são removidos, tal como as credenciais de URL, as query strings e os fragmentos. - Uma mensagem genérica para todo o resto:
secrets,vulnerability,env_parity,health_endpoint,stripe,index_now, todas as verificações de serviços e qualquer erro "Check failed:". - Um
preflight.ymlredigido: nome do projeto, stack, origens de URL, declarações de serviços e quais verificações estão ativadas. A chave IndexNow, o URL do webhook Stripe, a lista de permissões de segredos, os nomes dos ficheiros env, o caminho de saúde, o caminho do layout e a lista de ignorados são removidos.
Les suggestions, le contenu des fichiers, la sortie des outils d'audit et les valeurs secrètes ne sont jamais envoyés.
Crie uma conta gratuita e depois ligue a CLI:
preflight auth login # opens your browser to authorize this CLI
preflight auth status # show who you're logged in as
preflight auth logout # remove stored credentials
Publique um scan no seu dashboard com --publish. Ele imprime um link para visualizar a execução. A publicação é feita em regime de melhor esforço: se você estiver offline ou não estiver logado, o scan ainda é executado e encerra normalmente.
preflight scan --publish
No dashboard você obtém o detalhamento de aprovação/aviso/falha de cada execução, a lista de resultados das verificações e um histórico por projeto para que você possa ver o que mudou entre implantações.
Você também pode ler esse histórico a partir do terminal com preflight history:
preflight history # recent runs across your projects
preflight history --here # only the current project's runs
preflight history <run-id> # one run's full check results
preflight history --here --format json # machine-readable, for agents
Requer preflight auth login. --here associa as execuções ao repositório atual pelo seu git remote, a mesma chave usada ao publicar. Um app escaneado a partir de um subdiretório do seu repositório (um app em um monorepo) também é identificado por esse subdiretório, então apps/web e apps/api publicam em projetos separados no dashboard. history --format json carrega os mesmos campos schema_version e cli_version do JSON de scan.
Em CI ou outra máquina sem navegador, faça login com um token: preflight auth login --token - lê o token da entrada padrão, ou defina PREFLIGHT_TOKEN e execute preflight auth login. De qualquer forma, o token é verificado e armazenado como um login pelo navegador; os comandos seguintes leem as credenciais armazenadas, não a variável.
Abra qualquer verificação com falha ou aviso em uma execução publicada para gerar uma correção passo a passo adaptada à stack detectada, com comandos e código prontos para copiar.
- Gratuito inclui 5 execuções publicadas por mês.
- Traga sua própria chave: adicione uma chave de API da OpenAI ou Anthropic nas configurações do seu dashboard e a publicação permanece gratuita e ilimitada (você paga diretamente ao seu provedor).
- Gerenciado ($5/mês): nós cobrimos os custos de IA e as execuções são ilimitadas, sem necessidade de chave de API.