Skip to main content

🚀 Quickstart

Configure seu primeiro projeto com Squidy em 3 passos simples.

1. Instalação

pip install squidy
Verifique a instalação:
squidy --version

2. Inicialize seu Projeto

Execute o comando init para iniciar o setup interativo:
squidy init
O Squidy fará perguntas sobre seu projeto:
🦑 Setup com Agente IA

🤖 Agente: Olá! Me conte sobre o projeto que você quer configurar.
           Exemplo: "API REST para delivery com Node e PostgreSQL"
   
Você: API REST para delivery com Node e PostgreSQL

🤖 Agente: Legal! Qual framework frontend você vai usar?
   
Você: React com TypeScript

... (mais 2-3 perguntas contextuais) ...

✅ Configuração gerada com sucesso!

3. Use com sua IA

Após o setup, instrua seu agente de IA:
“Acesse ./readme-agent.md e siga o ritual de onboarding”
Ou para um projeto específico:
squidy init ./meu-novo-projeto

Comandos Úteis

ComandoDescrição
squidy initSetup interativo com IA
squidy auditAudita o projeto atual
squidy statusMostra status do projeto

Opções do Init

# Simular sem criar arquivos (dry-run)
squidy init --dry-run

# Setup manual (sem IA)
squidy init --manual

# Especificar diretório
squidy init ./meu-projeto

Próximos Passos

Comando Init

Detalhes completos do comando de inicialização.

Conceitos de Governança

Entenda como o Squidy estrutura a governança do projeto.