README_ES.md

litewiki

Una CLI local-first que genera informes estilo wiki para tu base de código.

English | 中文

Características

• CLI interactiva: wiki abre un menú sencillo (run, report, profile, config).
• Archivado de proyectos: los informes generados se guardan en tu directorio de configuración de usuario.
• Modo incremental: puede reutilizar el último informe archivado como entrada.
• Agente con herramientas: el agente explora tu repositorio mediante herramientas (listDirectory, readFile, renderMermaid).

Instalación

Requisitos:

• Node.js (ESM)
• pnpm (recomendado)

Instalar globalmente:

npm i -g litewiki
# o
pnpm add -g litewiki

Luego ejecuta:

wiki

Instalación para desarrollo

pnpm install
pnpm build

Luego ejecuta la CLI:

pnpm -s build
node dist/index.js

O enlázala localmente (opcional):

pnpm link --global
wiki

Inicio rápido

1. Crear una configuración de IA:

wiki config

Se te pedirá:

• provider: openai | anthropic | google | custom (openai y anthropic funcionan actualmente)
• model
• baseUrl
• key

2. Ejecutar:

wiki run .

Proveedores

Intencionalmente aplanamos los proveedores a:

provider: "openai" | "anthropic" | "google" | "custom"

• Soportados: openai, anthropic
• Aún no soportados (pero seleccionables en la UI): google, custom
• Nota sobre Anthropic: usa la API de Messages; establece baseUrl a https://api.anthropic.com/v1/messages.

Ver: docs/providers.md

Comandos

• wiki: menú interactivo
• wiki run [dir]: analizar un directorio
• wiki profiles: gestionar perfiles de prompt
• wiki reports: ver/eliminar informes archivados
• wiki config: gestionar configuraciones de IA

Desarrollo

pnpm test
pnpm lint
pnpm format
pnpm build
pnpm dev

Guía para agentes

Si estás usando un agente de código (Cursor/Copilot/etc.), consulta: AGENTS.md

Licencia

ISC © Carbon