xtop-cli / documentación
Documentación
Toda la documentación del ecosistema xtop-cli concentrada en un solo
lugar. Estas páginas son un espejo fiel de los README.md y los ficheros
docs/ de cada repositorio, traducido al español; el original en inglés
vive en /docs/en. Nada de este espejo se ha reescrito: si
cambia un repo, cambia su documentación.
El ecosistema se divide en siete repositorios con una única regla de
dependencia: cada consumidor depende solo de los crates de contratos de
api — nunca del kernel — así que cada repo compila de
forma independiente.
| Repo | Rol | Contenido |
|---|---|---|
xtop |
kernel | la aplicación: binario de un solo crate; consume al resto de repos |
api |
contratos | xtop-plugin-api · xtop-widget-api · xtop-effect-api · xtop-extension-api |
widgets |
renderers | packs de widgets sobre xtop-widget-api (pack por defecto + blocks) |
layouts |
disposición | xtop-layout: modelo de layout, loader JSONC, modos y presets |
plugins |
funcionalidad | implementaciones de plugins (primer miembro: xtop-plugin-samurai) |
extensions |
hooks del kernel | extensiones de tipo servidor (primera: xtop-extension-mcp) |
effects |
animación | efectos de frame (primero: xtop-effect-fade) |
Por dónde empezar
Si vienes de fuera del código, el orden natural es:
- Qué es → features y el README del kernel
- Instalarlo → installation — Linux, Windows, macOS y build desde el código fuente
- Usarlo → usage — keybindings, módulos, layouts adaptativos
- Configurarlo → configuration y customization (temas y layouts JSONC)
- Colores → colors — las 12 paletas
- Programar → contratos en api, packs en authoring de widgets, plugins y MCP en plugins y protocolo MCP de extensions
Nota: los enlaces entre ficheros se resuelven automáticamente hacia la ruta local equivalente cuando el destino está espejado aquí; el resto apunta al
blobreal en GitHub.
Espejos
| Repositorio | Ficheros |
|---|---|
xtop-cli/api |
README.md, docs/*.md |
xtop-cli/effects |
README.md, docs/*.md |
xtop-cli/extensions |
README.md, docs/*.md, extensions/xtop-extension-mcp/README.md |
xtop-cli/layouts |
README.md, docs/*.md, layouts/custom/README.md |
xtop-cli/plugins |
README.md, docs/*.md, plugins/xtop-plugin-samurai/README.md |
xtop-cli/widgets |
README.md, docs/*.md, custom/README.md |
xtop-cli/xtop |
README.md, docs/*.md, ROADMAP.md, CHANGELOG.md, CONTRIBUTING.md |
Xtop
La aplicación en sí: un monitor de sistema TUI multiplataforma escrito en Rust. Kernel de un solo crate con renderizado ratatui, providers de sysinfo y la superficie de comandos (config, temas, layouts, plugins, widgets, MCP).
13 docs
api
Crates de contratos puros: xtop-plugin-api, xtop-widget-api, xtop-effect-api y xtop-extension-api. Aquí vive el modelo de datos compartido (SystemSnapshot, AlertThresholds); el resto de repos solo depende de este.
8 docs
widgets
Packs de widgets (renderers) contra xtop-widget-api: el pack por defecto (11 widgets) más el pack blocks — un crate por widget, con el motor compartido xtop-widget-core.
4 docs
layouts
El crate xtop-layout: modelo de layout guiado por datos, loader JSONC, modos de layout y degradación por tamaño de terminal. Incluye 7 layouts de modo + 3 presets detail y la carpeta de layouts de la comunidad.
5 docs
plugins
Implementaciones de plugins contra xtop-plugin-api. Primer miembro: xtop-plugin-samurai — un plugin consciente de IA con 12 acciones JSON y 10 reglas heurísticas de detección de amenazas.
4 docs
extensions
Extensiones de tipo servidor contra xtop-extension-api. Primer miembro: xtop-extension-mcp — un servidor del Model Context Protocol sobre stdio que expone xtop y sus plugins alojados como tools MCP.
github.com/xtop-cli/extensions →
4 docs
effects
Efectos de frame contra xtop-effect-api. Primer miembro: xtop-effect-fade — funde el frame renderizado desde negro en 500 ms, determinista y sin configuración.
3 docs