跳到主要内容
文档

ptool

面向 shell 与自动化工作流的 Lua 脚本工具。

用 Lua 编写小而锋利的自动化脚本,再像命令行工具一样交付和使用它们。

example.lua
ptool.use("v0.1.0")

local who = ptool.ask("Deploy target?", {
  default = "staging",
})

ptool.run("echo", {"deploying", who})

先从入门指南开始,再进入按模块组织的 Lua API 文档,把它当作你的脚本手册。

为什么选择 ptool

面向自动化脚本的实用运行时

以脚本为先

直接编写普通 Lua 文件并用 ptool 运行。运行时会同时通过 ptool 和 p 暴露一组实用工具。

开箱即用

无需拼装一堆零散工具,就能直接使用语义化版本、文件、HTTP、SSH、模板、数据库和文本处理辅助能力。

适合命令行

把 shell 命令、参数解析、shebang 脚本和结构化 API 放在一个地方,构建真正能落地的自动化脚本。

面向 AI

给助手原始 Markdown,而不是渲染后的 HTML

ptool 会把源文档作为静态文件发布,方便 agent 直接读取原始 Markdown。

1. 从这里开始

先让助手读取 manifest 索引。它会指向按语言和版本拆分的更小 manifest。

/raw/manifest.json

3. 告诉模型要做什么

例如:先读 manifest 索引,再打开匹配的语言/版本 manifest,然后读取原始 Markdown,而不是抓取渲染后的站点。

Fetch /raw/manifest.json, open /raw/manifests/en/current.json, find the page for "/docs/unreleased/intro", then read its rawUrl.