- Desarrollada para hacer que los fragmentos de código dentro de la documentación sean realmente ejecutables, aumentando la utilidad y confiabilidad de runbooks, documentación operativa y README
- Permite ejecutar tal cual los bloques de código de Markdown, para seguir y validar fácilmente la documentación paso a paso
- Ejecuta comandos, revisa resultados intermedios y verifica si se logró la salida esperada
- Soporta múltiples runtimes basados en shebang como Shell/Bash, Python, JavaScript/TypeScript y Ruby
- Al ejecutar celdas de código, mantiene las variables de entorno y el contexto de ejecución, permitiendo una ejecución paso a paso como en una sesión de terminal
- También soporta un flujo de ejecución tipo pipeline que pasa la salida de una celda a la siguiente
- Es totalmente compatible con definiciones de tareas existentes como Makefile, npm scripts, Gradle y Deno task
- Con los comandos
run, list y print, permite explorar, ejecutar y validar flujos de trabajo ejecutables dentro de la documentación
- Reduce el problema de bitrot en la documentación operativa y es especialmente adecuado para documentación de trabajo que requiere ejecución paso a paso
- bitrot: fenómeno en el que la documentación o el código, con el paso del tiempo, deja de coincidir con el entorno real y pierde confiabilidad gradualmente
- Se puede instalar con Homebrew, npm, Go install o como binario único
- Licencia Apache 2.0
Aún no hay comentarios.