Versão da documentação · CLI 7.30.1 · SDK 2.6.53. O Desktop usa o runtime incluído na própria versão. Comandos e exemplos são preservados do original em inglês. Original em inglês

Criar e usar seu primeiro AX Wiki

Antes de começar

AX Wiki transforma fontes selecionadas do repositório em páginas de arquitetura e fluxos de trabalho. É conhecimento do repositório, separado da documentação do site AX Code. Primeiro conecte um provedor e escolha um modelo utilizável. A geração envia as evidências selecionadas a esse provedor e pode gerar cobranças.

Execute na pasta do projeto. Projetos Git usam a raiz do worktree mais próximo, mesmo começando em uma subpasta. Confira o checkout e decida se os arquivos gerados devem ser versionados.

Visualizar e gerar

O plano mostra arquivos e páginas selecionados sem chamar o modelo. Revise antes da geração:

ax-code wiki plan

Depois gere com o modelo configurado, valide o resultado e abra o leitor local:

ax-code wiki generate
ax-code wiki doctor
ax-code wiki viz --open

A saída padrão é .ax-wiki/, começando por .ax-wiki/quickstart.md; .ax-wiki/.manifest.json registra fontes e hashes. A geração pode atualizar o bloco de referências Wiki em AGENTS.md; use --skip-agents para pular essa etapa. Revise o diff resultante.

Ler e fazer perguntas úteis

Comece pela página introdutória, siga os arquivos citados e pergunte onde um fluxo está implementado. O visualizador mostra páginas, citações e relações registradas. Encerre o visualizador CLI em primeiro plano com Ctrl+C.

Use o Wiki para orientação, depois examine o código e os testes atuais. Para símbolos, chamadores e referências exatos, use inteligência de código ou LSP. Uma página atualizada não comprova cobertura completa, correção ou desempenho em execução.

Manter atualizado

Após mudanças nas fontes, atualize as páginas afetadas e confira sua integridade:

ax-code wiki update
ax-code wiki status
ax-code wiki doctor

O comando de status pode ter sucesso mesmo sem Wiki; confira a existência e a integridade informadas. Saída desatualizada ou com problemas exige investigação. O visualizador CLI usa uma captura fixa: reabra após atualizar.

Nas versões atuais do TUI, /wiki-viz abre o visualizador e solicita manutenção. A manutenção interativa durante a ociosidade vem ativada; o trabalho em primeiro plano tem prioridade. Execuções sem interface não ativam esse agendador.

Controlar a geração

Adicione estas opções ao ax-code.json do projeto. Substitua o ID por um modelo disponível na conexão. Este exemplo desativa a manutenção em segundo plano e mantém comandos explícitos:

{
  "wiki": {
    "enabled": true,
    "auto": false,
    "model": "provider/model"
  }
}

Um --model provider/model explícito substitui o modelo Wiki nessa chamada. Modelos de raciocínio exigem controles reconhecidos de raciocínio baixo ou desativado; selecione outro modelo compatível se essa política recusar a requisição.

Coloque notas dos mantenedores em blocos protegidos para preservá-las durante atualizações:

<!-- AX-WIKI:PROTECTED:START project-note -->

Deployment requires maintainer review.

<!-- AX-WIKI:PROTECTED:END -->

Recuperar de problemas

Sem modelo ou erro de autenticação: confira acesso ao provedor e modelo Wiki configurado. Um modelo de chat funcional não garante que outro modelo Wiki seja utilizável.
Tempo esgotado ou compilação interrompida: examine ax-code wiki doctor e .ax-wiki/.build-report.json, resolva a causa e tente novamente. Páginas temporárias validadas podem ser reutilizadas; falha na compilação não significa que todas as páginas foram publicadas.
Conflito de edição manual: preserve notas em blocos protegidos e revise as mudanças antes de tentar novamente. --force permite substituir edições fora desses blocos; use intencionalmente.

Próximos passos

Configuração Wiki, CI e solução de problemas · Visualizador e exportação offline · Seleção de modelos · Central de documentação