Agent Skills
返回列表
💻

用termshot捕获文档终端截图

开发编程 更新于 2026.08.29

将以下提示词粘贴到你的 AI 对话框中:

请根据 https://skillhub.cn/install/skillhub.md,安装 @user_3c6cb52e/capture-polished-terminal-screenshots-for-docs-and-changelogs-with-termshot。

技能介绍

终端截图为何总差一口气

写技术文档或变更日志时,一张清晰的终端截图能省下大量解释成本。但手动复制粘贴、调整窗口大小、裁掉多余滚动条,既耗时又难保持一致性。更麻烦的是,当文档随版本迭代,截图与实际输出逐渐脱节,读者看到的是过时界面,维护者却要反复更新。

用 termshot 把截图流程固定下来

这个技能围绕 termshot 展开,核心是把「生成终端截图」变成可重复、可自动化的步骤。你需要先准备好要捕获的终端输出——可以是命令的直接结果,也可以通过 shell 脚本或 CI 步骤生成。然后调用 termshot,它会稳定渲染终端画面,输出为图片文件,存放在指定的可写路径中。后续无论是嵌入 Markdown 文档、发行说明还是运行手册,直接引用这张图即可。

关键能力包括:

  • 稳定的渲染框架:避免不同终端环境导致的显示差异。
  • 可脚本化集成:配合 shell 或 CI,截图成为构建流程的一部分。
  • 输出可控:路径可指定,方便与文档仓库同步。

适用边界与注意点

termshot 适合静态文档的截图需求,尤其推荐在 CI 中运行以保证每次截图风格统一。但它不适用于实时交互式终端,也无法捕获需要用户输入的会话。使用前需确保环境已安装 termshot,且输出路径有写入权限。若终端输出包含敏感信息,记得在截图前做脱敏处理。

使用场景

  • 编写项目 README 时,需要把命令执行结果截成清晰的终端图片,嵌入 Markdown 文档
  • 发布新版本前,为发行说明和变更日志批量生成风格统一的终端截图
  • 在 CI 流水线中自动捕获命令输出并保存为截图,作为构建过程的存档记录
  • 撰写运维运行手册时,需要展示命令在真实终端里的实际输出效果

适合人员

  • 技术文档工程师,需要在教程和 API 文档中插入准确的终端运行截图
  • DevOps 工程师,需要在 CI 流水线里为每次构建生成标准化的终端输出记录
  • 开源项目维护者,需要为 release notes 和文档提供风格统一的终端截图
  • 后端开发工程师,撰写故障排查手册时需要展示命令的真实执行结果