Skip to content

v4-quick-start.md

Latest commit

 

History

History
269 lines (192 loc) · 7.35 KB

v4-quick-start.md

File metadata and controls

269 lines (192 loc) · 7.35 KB
Raw

Guia de Início Rápido AIOX v4

🌐 EN | PT | ES

Versão: 2.1 Última Atualização: 2026-01-26 Tempo para Completar: 5 minutos

Pré-requisitos

Antes de começar, certifique-se de ter:

  • Node.js 18+ instalado (node --version)
  • npm 9+ instalado (npm --version)
  • Git instalado (git --version)
  • GitHub CLI (gh) instalado e autenticado (gh auth status)
  • Uma IDE com IA ou Claude Code CLI

Passo 1: Instalar AIOX Core

Opção A: Wizard de Instalação npx (Recomendado)

# Executar o wizard de instalação interativo
npx aiox-core@latest

# Ou criar um novo projeto com nome específico
npx aiox-core@latest init meu-projeto
cd meu-projeto

Opção B: Clonar Repositório (Desenvolvimento)

git clone https://github.com/SynkraAI/aiox-core.git
cd aiox-core
npm install

Passo 2: Verificar Instalação

Execute o comando de diagnóstico:

npx aiox-core@latest doctor

Ou se instalado globalmente:

aiox doctor

Verificação Manual

# Verificar se a estrutura core existe
ls -la .aiox-core/

# Verificar diretórios principais
ls .aiox-core/core/
ls .aiox-core/development/agents/

Estrutura esperada:

.aiox-core/
├── core/               # Core do framework (registry, health-check, orchestration)
├── development/        # Agentes, tarefas, workflows
├── product/            # Templates, checklists
└── infrastructure/     # Scripts, ferramentas, integrações

Passo 3: Ativar Seu Primeiro Agente

AIOX usa agentes especializados para diferentes tarefas. Na sua IDE com IA ou Claude Code CLI, digite:

@aiox-master

O agente irá cumprimentá-lo e mostrar comandos disponíveis:

🎯 AIOX Master pronto!
Digite *help para ver comandos disponíveis.

Experimente Estes Comandos

Comando Descrição
*help Mostrar todos os comandos disponíveis
*status Mostrar status do projeto
*agents Listar todos os agentes disponíveis

Passo 4: Explorar Agentes Disponíveis

Agente Ativação Propósito
@dev (Dex) Desenvolvimento Implementação de código, debugging
@qa (Quinn) Qualidade Testes e validação
@architect (Aria) Arquitetura Design de sistema e documentação
@pm (Sage) Product Manager Requisitos e planejamento
@devops (Gage) DevOps Git push, criação de PR, CI/CD
@po (Maven) Product Owner Criação de stories e backlog
@sm (River) Scrum Master Gerenciamento de sprint
@analyst (Nova) Analista de Negócios Análise de requisitos

Exemplo: Ativar Agente Desenvolvedor

@dev

O agente desenvolvedor (Dex) será ativado com uma saudação mostrando:

  • Status do projeto
  • Comandos rápidos
  • Opções de colaboração entre agentes

Passo 5: Criar Sua Primeira Story

Stories direcionam o desenvolvimento no AIOX. Ative o Product Owner e crie uma:

@po *create-story

Siga os prompts para definir:

  1. Título da story
  2. Descrição
  3. Critérios de aceite
  4. Prioridade

Referência Rápida

Comandos de Agente

Todos os comandos de agente usam o prefixo *:

*help          # Mostrar ajuda
*status        # Mostrar status
*exit          # Sair do agente atual

Comandos CLI

# Instalação e setup
npx aiox-core@latest           # Executar wizard
npx aiox-core@latest doctor    # Executar diagnósticos
npx aiox-core@latest info      # Mostrar info do sistema

# Desenvolvimento
npm run lint                           # Verificar estilo de código
npm run typecheck                      # Verificar tipos TypeScript
npm test                               # Executar testes unitários
npm run validate:structure             # Validar estrutura AIOX

Estrutura do Projeto

seu-projeto/
├── .aiox-core/                    # Core do framework
│   ├── core/                      # Módulos core
│   │   ├── registry/              # Registro de serviços (200+ workers)
│   │   ├── health-check/          # Sistema de health check
│   │   ├── orchestration/         # Orquestração de workflows
│   │   └── quality-gates/         # Camadas de validação de qualidade
│   ├── development/               # Assets de desenvolvimento
│   │   ├── agents/                # Definições de agentes (12 agentes)
│   │   ├── tasks/                 # Workflows de tarefas (~140 tarefas)
│   │   └── workflows/             # Workflows multi-etapa
│   ├── product/                   # Assets de produto
│   │   ├── templates/             # Templates de documentos
│   │   └── checklists/            # Checklists de validação
│   └── infrastructure/            # Infraestrutura
│       ├── scripts/               # Scripts utilitários (~80)
│       ├── integrations/          # Adaptadores de PM tools
│       └── templates/             # Templates de configuração
├── .claude/                       # Configuração Claude Code
│   ├── commands/AIOX/agents/      # Skills de agentes
│   └── rules/                     # Regras de agentes
├── docs/                          # Documentação
│   └── stories/                   # Stories de desenvolvimento
└── src/                           # Seu código fonte

Próximos Passos

  1. Leia o guia completo: Começando
  2. Entenda a arquitetura: Arquitetura Core
  3. Aprenda sobre agentes: Definições de Agentes
  4. Junte-se à comunidade: Discord

Solução de Problemas

Erros "Comando não encontrado"

# Certifique-se que Node.js está no PATH
node --version

# Limpe o cache npm se problemas persistirem
npm cache clean --force

Agente não responde

  1. Certifique-se de estar em uma IDE com IA (Cursor, VS Code com Claude, etc.) ou Claude Code CLI
  2. Verifique se está usando sintaxe correta: @nome-do-agente
  3. Verifique se o arquivo do agente existe: ls .aiox-core/development/agents/

Erros de permissão

# Corrigir permissões npm (macOS/Linux)
sudo chown -R $(whoami) ~/.npm

# Ou use um gerenciador de versão Node (recomendado)
# nvm, fnm, ou volta

Estrutura AIOX não encontrada

# Reinstalar AIOX no projeto atual
npx aiox-core@latest install

# Ou clonar novamente
git clone https://github.com/SynkraAI/aiox-core.git

Obtendo Ajuda

Bem-vindo ao AIOX! Bom coding!