statefulhq/runme
statefulhq
直接从Markdown文件（如运行手册、文档或README）中发现并运行代码片段，使运行手册可执行，简化分步操作流程，支持执行指令、检查中间结果，兼容多种任务定义。
下载次数: 0状态：社区镜像维护者：statefulhq仓库类型：镜像最近更新：1 个月前
让 AI 帮你使用轩辕镜像？ · 展开查看说明
如果你使用 DeepSeek、元宝 AI、Copilot、ChatGPT 等 AI 工具，协助配置轩辕镜像、编写 docker pull 命令、修改 Docker Compose 镜像地址、配置镜像加速、排查镜像拉取失败、分析报错日志等问题，请先让 AI 阅读并遵守轩辕镜像的规则文档。
只需在 AI 对话中先发送下面这句话即可：
请先完整阅读并严格遵守以下文档中的全部规则与要求：
https://xuanyuan.cloud/agents.md
在未充分阅读并理解该文档前，不要生成任何命令、配置、修改建议、故障排查方案或技术回答。后续所有输出都必须严格以该文档中的规范为最高优先级执行。查看 agents.md 用法指南与完整示范。国内用户首推 元宝 AI、DeepSeek 的深度思考模式，不推荐豆包 AI；Cursor 等编辑器可在对话 @ 该链接，或加入 User Rules。 若 AI 无法访问外链，可 打开说明文档 复制全文粘贴。文档会随站点更新，复制内容可能过期，建议定期检查。
Runme：运行Markdown中的代码片段
直接从Markdown文件（如运行手册、文档或README）中发现并运行代码片段（默认使用本地
README.md）。
Runme是一款让运行手册真正可执行的工具，旨在简化分步操作流程。用户可直接执行指令、检查中间结果并确保获得期望输出；作者能创建预定义的黄金路径并共享给他人。该工具结合了流水线的约束性与脚本的灵活性，允许用户在继续下一步前验证中间结果。
Runme通过直接运行Markdown文件（仓库内文档的常用格式）实现上述功能，具体而言，它可执行围栏代码块（shell、bash、zsh等）中的命令。其100%兼容各类编程语言的任务定义（如Makefile、Gradle、Grunt、NPM脚本、Pipfile或Deno任务等），并将运行手册持久化在Markdown中，与现有文档体系无缝衔接。
安装
从Docker Hub拉取镜像：
sh# 常规拉取 docker pull statefulhq/runme # MacOS Silicon平台 docker pull --platform linux/x86_64 statefulhq/runme
运行示例（查看版本）：
shdocker run docker.io/statefulhq/runme:latest --version
更多信息
关于Runme CLI的命令及参数详情，可查阅官方文档。
示例
完整的使用案例示例可参考官方文档示例库，涵盖多种应用场景。
反馈
通过https://github.com/stateful/runme/issues/new%E6%8F%90%E4%BA%A4%E5%8F%8D%E9%A6%88%E6%88%96PR%EF%BC%8C%E4%B9%9F%E5%8F%AF%E5%8A%A0%E5%85%A5***%E7%A4%BE%E5%8C%BA%E5%8F%82%E4%B8%8E%E8%AE%A8%E8%AE%BA%E3%80%82
社区
加入Runme社区：
- 在***提问交流
- 在博客阅读实际应用案例
- 通过社区会议了解路线图与最新进展
- 订阅newsletter获取更新
许可证
Apache License, Version 2.0
镜像拉取方式
您可以使用以下命令拉取该镜像。请将 <标签> 替换为具体的标签版本。如需查看所有可用标签版本，请访问 标签列表页面。
DockerHub 原生拉取命令
docker pull statefulhq/runme:<标签>
镜像拉取常见问题
功能
错误码
用户好评
来自真实用户的反馈，见证轩辕镜像的优质服务
oldzhang
运维工程师
Linux服务器
5
"Docker访问体验非常流畅，大镜像也能快速完成下载。"