# WordPress 远程 CLI (wpklx) wpklx 是 WordPress REST API 的动态 CLI。它在运行时从“/wp-json”发现路由——由 WordPress 核心或插件注册的任何资源都会自动成为 CLI 命令。 ## 安装卷曲-fsSL https://raw.githubusercontent.com/KLIXPERT-io/wpklx/main/install.sh |巴什 ## 快速开始 wpklx login # 交互式设置（主机、用户名、应用程序密码） wpklx discovery # 获取并缓存 API 模式 wpklx 路由 # 列出所有可用命令 wpklx post list # 列出已发布的帖子 wpklx post get 42 # 通过 ID 获取帖子 wpklx post create --title "Hello World" # 创建一个新帖子 ## 语法 wpklx [@profile] <资源> <操作> [id] [--选项值] [标志] * `@profile` — 可选，选择一个命名站点配置文件（例如，`@staging`、`@local`） * `` — WordPress 资源（帖子、页面、媒体、用户、类别、标签、评论或任何插件资源） * `` — CRUD 操作或快捷方式 * `[id]` — 位置 ID（替代 `--id `） * `[--option value]` — API 模式中特定于资源的参数 ## 操作和快捷键行动|快捷方式| HTTP |描述 ---|---|---|--- `列表` | `ls` |获取 |列出项目 `获取` | `显示` |获取 |获取单个项目 `创建` | `新` |发布 |创建项目 `更新` | `编辑` |放置/修补|更新项目 `删除` | `rm` |删除 |删除项目 ## 内置命令 wpklx login # 交互式站点设置向导 wpklx discovery # 强制刷新 API 模式缓存 wpklx paths # 列出所有发现的路由 wpklx help # 全局帮助 wpklx help # 带参数的资源特定帮助 wpklx 版本 # 打印版本 wpklx serialize # 将 HTML 转换为 WordPress 块 HTML（独立） wpklx markdown # 将 Markdown 转换为 WordPress 块 HTML（独立） ### 档案管理 wpklx config ls # 列出所有配置文件 wpklx config show # 显示活动配置文件详细信息 wpklx config show @staging # 显示特定配置文件 wpklx config add # 以交互方式添加新配置文件 wpklx config rm # 删除配置文件 wpklx config default # 设置默认配置文件 wpklx config path # 打印使用中的配置文件路径 ## 全局标志 --format 输出格式（默认：表） --fields 逗号分隔的字段，或每列的“all” --per-page 每页项目数（默认值：20） --page 页码 --quiet 仅输出 ID（每行一个） --verbose 显示 HTTP 请求/响应详细信息 --no-color 禁用 ANSI 颜色 --env 自定义 .env 文件的路径 --serialize 在发送之前将 HTML 内容转换为阻止 HTML --markdown 在发送之前将 Markdown 内容转换为阻止 HTML --no-h1 剥离第一个 H1（与 --serialize 或 --markdown 一起使用） --help, -h 显示帮助 --version, -v 显示版本标志接受 `--flag value` 和 `--flag=value` 语法。 ## 命名空间前缀当插件注册同名资源时，使用命名空间前缀： wpklx wpml:post list # WPML插件的帖子资源 wpklx woocommerce:产品列表 # WooCommerce 产品 wpklx myplugin:settings get # 自定义插件设置如果没有前缀，`wp/v2` 核心路由优先。 ## 标准输入管道 ### 使用 `--flag -` 显式映射回声“你好世界”| wpklx post create --content - --title "我的帖子" 猫草稿.md | wpklx页面更新12--内容- 猫照片.jpg | wpklx 媒体上传--文件--标题“英雄” ### 裸管（自动映射）当没有指定 `--flag -` 时，stdin 映射到一个合理的默认值：资源 |默认参数 ---|--- 帖子、页面 | `内容` 评论 | `内容` 类别、标签 | `描述` 媒体| `文件` _其他_ | `内容` echo“发布正文”| wpklx post create --title“自动映射” 猫文章.md | wpklx post create --title“来自 Markdown”--markdown 标准输入仅适用于写入操作（创建、更新）。如果默认参数已通过 CLI args 提供，则裸管道标准输入将被忽略。 ## 媒体上传 wpklx 媒体上传 --file ./photo.jpg --title "英雄图片" wpklx 媒体上传 --file ./doc.pdf --title "报告" 猫图片.png | wpklx 媒体上传 --file - --title "Piped" --mime-type image/png 卷曲 -s https://example.com/img.jpg | wpklx 媒体上传 --file - --title "已下载" MIME 类型是根据文件扩展名自动检测的。在管道传输二进制数据时使用“--mime-type”进行覆盖。 ## 内容转换 ### 内联（带有创建/更新） # 将 Markdown 内容即时转换为 WordPress 块 wpklx post create --title "我的帖子" --content "# Hello\n\nParagraph" --markdown # 将 HTML 转换为块 wpklx post update 42 --content "

更新

新内容

" --serialize # 转换前去掉第一个 H1 猫文章.md | wpklx post create --title "文章" --markdown --no-h1 ### 独立命令 # 将 HTML 文件转换为块 HTML wpklx序列化--文件article.html--输出article.blocks.html 猫页面.html | wpklx序列化--no-h1>blocks.html # 将 Markdown 文件转换为块 HTML wpklx markdown --文件草稿.md --输出草稿.blocks.html 猫自述文件.md | wpklx markdown > readme.blocks.html ## 输出格式 ### 表（默认）自动选择基本列（id、标题、slug、状态、日期）。使用 `--fields` 进行自定义： wpklx 帖子列表 # 默认列 wpklx 帖子列表 --fields=all # 每列 wpklx 帖子列表 --fields=id,title,status,date # 特定列 ### JSON wpklx 帖子列表 --format json wpklx post get 42 --format json ### YAML wpklx 帖子列表 --format yaml ### 安静（仅限 ID） wpklx 帖子列表 --quiet #1 #42 #103 ## 个人资料使用“@name”在 WordPress 站点之间切换： wpklx @生产帖子列表 wpklx @staging post create --title“测试” wpklx @local page ls --status 草稿 wpklx 帖子列表 # 使用默认配置文件配置文件在“wpklx.config.yaml”（本地）或“~/.config/wpklx/config.yaml”（全局）中定义。配置解析顺序：CLI 标志 > .env 文件 > 活动 YAML 配置文件 > 内置默认值。 ## 错误处理 wpklx 使用指数退避重试暂时性故障（网络错误、429、502、503、504）。它不会重试身份验证或验证错误。当找不到资源或操作时，wpklx 使用模糊匹配建议类似的命令。 ### 退出代码代码|含义 ---|--- 0 |成功 1 |一般错误 2 |配置错误 3 |认证错误 4 |找不到资源 5 |验证错误 6 |网络/超时 ## 最佳实践 * 安装或删除 WordPress 插件后始终运行“wpklx discovery”以刷新路由缓存。 * 在构建命令之前，使用“wpklx help”查看资源的所有接受的参数。 * 当你需要解析输出或链命令时使用 `--format json`。 * 使用 `--quiet` 获取脚本 ID（例如，通过管道传输到 xargs）。 * 使用 `--verbose` 来调试身份验证或网络问题。 * 在选择特定字段之前，使用 `--fields=all` 检查完整的数据形状。 * 为简洁起见，优先使用位置 ID（`wpklx post get 42`）而不是 `--id 42`。 * 当第一个标题与帖子标题重复时，请使用“--serialize”或“--markdown”与“--no-h1”。 ## 复杂的例子 ### 批量发布所有草稿帖子 wpklx 帖子列表--状态草稿--安静 | xargs -I {} wpklx post update {} --status 发布 ### 使用块序列化从 Markdown 文件创建帖子猫文章.md | wpklx 帖子创建 \ --title “TypeScript 完整指南”\ --状态草稿\ --类别 5,12 \ --标签 8,15,23 \ --markdown \ --没有-h1 ### 上传图片并将其设置为帖子的特色图片 MEDIA_ID=$(wpklx 媒体上传 --file ./hero.jpg --title "英雄图片" --quiet) wpklx 更新后 42 --featured_media "$MEDIA_ID" ### 镜像帖子从制作到登台 wpklx @生产帖子列表 --format json --fields=标题、内容、状态、类别 \ | jq -c '.[]' \ |在阅读-r帖子时；做 title=$(echo "$post" | jq -r '.title.rendered // .title') content=$(echo "$post" | jq -r '.content.rendered // .content') 回声“$内容”| wpklx @staging post create --title "$title" --content - --status 草稿完成 ### 将所有页面导出到单独的 JSON 文件 for id in $(wpklx page list --quiet --per-page 100);做 wpklx页面获取“$id”--format json>“page-${id}.json” 完成 ### 批量删除所有垃圾帖子 wpklx 帖子列表 --status 垃圾 --quiet | xargs -I {} wpklx post删除{} --force ### 从 HTML 文件创建页面，序列化为块 wpklx 页面创建 \ --标题“关于我们”\ --content "$(cat about.html)" \ --序列化\ --no-h1 \ --状态发布 ### 查找特定作者的帖子并重新分配它们 wpklx 帖子列表 --作者 3 --安静 | xargs -I {} wpklx 更新后 {} --author 7 ### 列出具有特定字段的所有在售 WooCommerce 产品 wpklx woocommerce:产品列表 --on_sale true --fields=id,名称,价格,sale_price --每页 50 ### 多站点内容审核：比较各个配置文件的帖子计数 echo“生产：$(wpklx @生产帖子列表 --quiet --per-page 1 2>/dev/null | wc -l) 帖子” echo“暂存：$(wpklx @staging post list --quiet --per-page 1 2>/dev/null | wc -l) posts” ### 从一个目录上传多个图像对于./images/*.jpg 中的img；做 wpklx 媒体上传 --file "$img" --title "$(basename "$img" .jpg)" --quiet 完成 ### 使用内联 Markdown 内容创建帖子 wpklx 帖子创建 \ --title “发行说明 v2.0” \ --content“## 新增内容 - **深色模式** — 全主题用户界面 - **性能** — 页面加载速度提高 3 倍 - **API v2** — 用于集成的新端点 ## 重大变更 \`/v1/legacy\` 端点已被删除。升级之前迁移到 \`/v2/modern\`。” \ --markdown \ --状态草稿 ### 链发现与新站点的路由检查 wpklx @newsite 发现 && wpklx @newsite 路线 ### 有条件更新：仅在帖子存在时发布如果 wpklx post get 42 --quiet 2>/dev/null;然后 wpklx 发布更新 42 --status 发布否则 echo "未找到 42 号帖子" 菲

Wordpress 远程 CLI

包含技能