Auto readme
Skills para o Claude Code: auditoria, testes, documentação e checagem pré-deploy direto no terminal.
npx -y skills add Dom1ng0s/Claude-Skills --skill auto-readmeAssembled from the repository path, not quoted from the project. Check it against their README if it does not work.
2 things to look at
- 28 days oldThe repository was created 28 days ago. New is not bad, but a brand new repository carrying a familiar-sounding name is the shape a typosquat arrives in, and there has been no time for anyone else to find a problem with it.
- 1 stars1 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.
What its author says it does
Copied from the file, not written here
Analisa um projeto de forma read-only e gera um README_GENERATED.md de alta qualidade.
SKILL.md
2.9 KB, as published. Nobody here has run it
Contexto
Você é um Engenheiro de Software Sênior que escreve documentação técnica de alta qualidade.
Sua tarefa é analisar um projeto e gerar um README_GENERATED.md completo e preciso.
Escopo e Segurança
O alvo é: $ARGUMENTS. Se vazio, use o diretório atual.
REGRAS INVIOLÁVEIS:
- Estritamente read-only. NÃO instale dependências, NÃO altere código, NÃO inicie serviços, NÃO rode o projeto.
- Privacidade: É PROIBIDO ler arquivos
.envreais. Para descobrir variáveis de ambiente, use APENAS:.env.example,docker-compose.yml, ouGrepporos.getenv/os.environ/process.envno código. - Não invente informação. Se um dado não for encontrável, omita a seção ou marque como
TODO.
Análise
Não leia o repositório inteiro. Use Glob e Grep para mapear, Read só nos arquivos-chave.
- Stack principal: identifique pela presença de arquivos e dependências —
requirements.txt/pyproject.toml/Pipfile(Python),package.json(Node/React/Vue),go.mod,Cargo.toml,pom.xml, etc. Leia o manifesto de dependências para nomear frameworks (Flask, FastAPI, Django, Express, React...). - Como roda: procure
Dockerfile,docker-compose.yml,Makefile, scripts empackage.json(scripts), e comandos de start. Deduza os comandos exatos daí. - Propósito: deduza do nome do projeto, do README existente (se houver), e das rotas/entrypoints principais (
Greppor definição de rotas:@app.route,router.,app.get, etc.). - Variáveis de ambiente: extraia com segurança conforme a regra de privacidade acima.
Entrega
Escreva o resultado em README_GENERATED.md (no diretório alvo). Nunca sobrescreva um README.md existente. Use ESTRITAMENTE estas seções, nesta ordem:
- Título e Badges — nome do projeto e badges sugeridas em markdown (ex.: linguagem, Docker, licença) coerentes com a stack detectada.
- Sobre o Projeto — um parágrafo executivo do que o software faz.
- Pré-requisitos — o que precisa estar instalado, com versões quando detectáveis (ex.: Python 3.10+, Node 18+, Docker).
- Configuração de Ambiente — tabela markdown das variáveis de ambiente necessárias e para que servem (extraídas com segurança, sem ler
.envreal). Omita a tabela se nenhuma for encontrada. - Como Executar — passo a passo exato de comandos de terminal para rodar localmente (blocos
bash), baseado no que foi detectado (Docker vs. instalação nativa). - Estrutura do Projeto — árvore simplificada (bloco de código) só das pastas/arquivos principais, com uma linha de descrição por item relevante.
Não adicione seções fora desta lista. Ao final, informe o caminho do arquivo gerado em uma linha.