johnpapa/ai-ready

O que ai-ready faz?

Plugin de CLI do Copilot que analisa seu repositório e gera configuração pronta para IA — AGENTS.md, copilot-instructions, skills, CI, templates de issues e muito mais.

Funcionalidades

• Análise automática do repositório: Detecta estrutura de pastas, arquivos de configuração e dependências.
• Geração de AGENTS.md: Cria um guia de contexto para agentes de IA explicando a arquitetura e as convenções do projeto.
• Configuração do Copilot: Gera arquivos .github/copilot-instructions.md com instruções personalizadas para o GitHub Copilot.
• Definição de skills: Produz arquivos de skill no formato adequado para plataformas como Claude Code e Cursor.
• Pipeline de CI: Gera workflows do GitHub Actions para testes, lint e deploy.
• Templates de issues: Cria templates padronizados para issues e pull requests.

Como usar

1. Instale o plugin via CLI do Copilot:

   gh extension install johnpapa/ai-ready
   

2. Navegue até o diretório do seu repositório:

   cd /caminho/para/seu/repositorio
   

3. Execute o comando de análise:

   ai-ready analyze
   

4. Revise e personalize os arquivos gerados no diretório ./ai-ready/.

Opções

Opção	Descrição
--output	Diretório de saída para os arquivos gerados (padrão: ./ai-ready/)
--force	Sobrescreve arquivos existentes sem confirmação
--skip-ci	Pula a geração de pipelines de CI
--lang	Especifica a linguagem principal do projeto (auto-detectada por padrão)

Exemplos

Analisar o repositório atual e gerar configuração completa:

ai-ready analyze

Gerar apenas arquivos AGENTS.md e instruções do Copilot, pulando CI:

ai-ready analyze --skip-ci

Forçar sobrescrita de arquivos existentes:

ai-ready analyze --force

Arquivos gerados

• AGENTS.md — Guia de contexto para agentes de IA
• .github/copilot-instructions.md — Instruções personalizadas para o GitHub Copilot
• .github/workflows/ — Workflows de CI
• .github/ISSUE_TEMPLATE/ — Templates de issues
• skills/ — Definições de skills para plataformas de IA

Requisitos

• GitHub CLI (gh) versão 2.0 ou superior
• Git 2.0 ou superior
• Acesso de leitura ao repositório

Suporte

Reporte bugs e solicitações de funcionalidades em github.com/johnpapa/ai-ready/issues.

Licença

MIT