Versión de la documentación · CLI 7.30.1 · SDK 2.6.53. Desktop utiliza el runtime incluido en su propia versión. Los comandos y ejemplos se conservan del original en inglés. Original en inglés

Crear y usar tu primer AX Wiki

Antes de empezar

AX Wiki transforma fuentes seleccionadas del repositorio en páginas de arquitectura y procesos. Es conocimiento del repositorio, distinto de la documentación web de AX Code. Primero conecta un proveedor y elige un modelo utilizable. La generación envía las pruebas seleccionadas a ese proveedor y puede generar cargos.

Ejecuta desde la carpeta del proyecto. Los proyectos Git usan la raíz del worktree más cercano, incluso desde un subdirectorio. Comprueba el checkout y decide si los archivos generados deben versionarse.

Previsualizar y generar

El plan muestra los archivos y páginas seleccionados sin llamar al modelo. Revísalo antes de generar:

ax-code wiki plan

Después genera con el modelo configurado, valida el resultado y abre el lector local:

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

La salida predeterminada es .ax-wiki/, empezando por .ax-wiki/quickstart.md; .ax-wiki/.manifest.json registra fuentes y hashes. La generación puede actualizar el bloque de referencias Wiki en AGENTS.md; usa --skip-agents para omitir ese paso. Revisa el diff resultante.

Leer y plantear preguntas útiles

Empieza por la página introductoria, sigue los archivos citados y pregunta dónde se implementa un proceso. El visor muestra páginas, citas y relaciones registradas. Detén el visor CLI en primer plano con Ctrl+C.

Usa el Wiki para orientarte y después examina código y pruebas actuales. Para símbolos, llamadores y referencias exactos usa inteligencia de código o LSP. Una página actualizada no demuestra cobertura completa, corrección ni rendimiento real.

Mantener actualizado

Tras cambios en las fuentes, actualiza las páginas afectadas y comprueba su estado:

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

El comando de estado puede terminar correctamente aunque no exista Wiki; comprueba la existencia y salud indicadas. Una salida obsoleta o defectuosa requiere investigación. El visor CLI muestra una instantánea fija: vuelve a abrirlo tras actualizar.

En las versiones TUI actuales, /wiki-viz abre el visor y solicita mantenimiento. El mantenimiento interactivo durante la inactividad viene activado; el trabajo en primer plano tiene prioridad. Las ejecuciones sin interfaz no activan este planificador.

Controlar la generación

Integra estas opciones en el ax-code.json del proyecto. Sustituye el ID por un modelo disponible mediante tu conexión. Este ejemplo desactiva el mantenimiento en segundo plano, conservando los comandos explícitos:

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

Un --model provider/model explícito sustituye el modelo Wiki para esa invocación. Los modelos de razonamiento necesitan controles reconocidos para razonamiento bajo o desactivado; elige otro modelo compatible si esta política rechaza la solicitud.

Coloca las notas de mantenimiento en bloques protegidos para conservarlas al actualizar:

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

Deployment requires maintainer review.

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

Recuperarse de problemas

Sin modelo o error de autenticación: comprueba el acceso al proveedor y el modelo Wiki configurado. Un modelo de chat funcional no garantiza que otro modelo Wiki sea utilizable.
Tiempo agotado o compilación interrumpida: revisa ax-code wiki doctor y .ax-wiki/.build-report.json, resuelve la causa y vuelve a intentarlo. Las páginas temporales validadas pueden reutilizarse; una compilación fallida no significa que todas las páginas se hayan publicado.
Conflicto de edición manual: conserva las notas en bloques protegidos y revisa los cambios antes de reintentar. --force permite reemplazar ediciones fuera de esos bloques; úsalo deliberadamente.

Siguientes pasos

Configuración Wiki, CI y solución de problemas · Visor y exportación sin conexión · Selección de modelos · Inicio de documentación