跳到主要内容

Xurl

通过 xurl CLI 使用 X/Twitter:发帖、搜索、私信、媒体、v2 API。

技能元数据

来源捆绑(默认安装)
路径skills/social-media/xurl
版本1.1.1
作者xdevplatform + openclaw + Hermes 智能体
许可证MIT
平台linux, macos
标签twitter, x, social-media, xurl, official-api

参考:完整的 SKILL.md

信息

以下是 Hermes 在触发此技能时加载的完整技能定义。这是当技能激活时智能体看到的指令。

xurl — 通过官方 CLI 访问 X (Twitter) API

xurl 是 X 开发者平台为 X API 提供的官方 CLI 工具。它支持常见操作的快捷命令,以及对任意 v2 端点的原始 curl 风格访问。所有命令均将 JSON 输出到 stdout。

使用此技能进行:

  • 发布、回复、引用、删除帖子
  • 搜索帖子和读取时间线/提及
  • 点赞、转发、收藏
  • 关注、取消关注、屏蔽、静音
  • 私信
  • 媒体上传(图片和视频)
  • 对任意 X API v2 端点的原始访问
  • 多应用/多账户工作流

此技能取代了较早的 xitter 技能(该技能封装了一个第三方 Python CLI)。xurl 由 X 开发者平台团队维护,支持带自动刷新的 OAuth 2.0 PKCE,并覆盖更广泛的 API 功能。


密钥安全(强制要求)

在智能体/LLM 会话中操作时的关键规则:

  • 切勿读取、打印、解析、总结、上传或发送 ~/.xurl 到 LLM 上下文。
  • 切勿要求用户将凭据/令牌粘贴到聊天中。
  • 用户必须在其自己的机器上手动填写 ~/.xurl 中的密钥。
  • 切勿在智能体会话中推荐或执行包含内联密钥的认证命令。
  • 切勿在智能体会话中使用 --verbose / -v —— 它可能暴露认证头/令牌。
  • 要验证凭据是否存在,请仅使用:xurl auth status

智能体命令中禁止的标志(它们接受内联密钥): --bearer-token--consumer-key--consumer-secret--access-token--token-secret--client-id--client-secret

应用凭据注册和凭据轮换必须由用户在智能体会话之外手动完成。注册凭据后,用户使用 xurl auth oauth2 进行认证 —— 同样在智能体会话之外。令牌以 YAML 格式持久化到 ~/.xurl。每个应用拥有独立的令牌。OAuth 2.0 令牌会自动刷新。


安装

选择一种方法。在 Linux 上,shell 脚本或 go install 是最简单的。

# Shell 脚本(安装到 ~/.local/bin,无需 sudo,适用于 Linux + macOS)
curl -fsSL https://raw.githubusercontent.com/xdevplatform/xurl/main/install.sh | bash

# Homebrew (macOS)
brew install --cask xdevplatform/tap/xurl

# npm
npm install -g @xdevplatform/xurl

# Go
go install github.com/xdevplatform/xurl@latest

验证:

xurl --help
xurl auth status

如果 xurl 已安装但 auth status 显示无应用或无令牌,则用户需要手动完成认证 —— 请参阅下一节。


一次性用户设置(用户在智能体外运行这些命令)

这些步骤必须由用户直接执行,而非由智能体执行,因为它们涉及粘贴密钥。引导用户阅读此部分;不要为他们执行这些命令。

  1. https://developer.x.com/en/portal/dashboard 创建或打开一个应用

  2. 将重定向 URI 设置为 http://localhost:8080/callback

  3. 复制应用的客户端 ID 和客户端密钥

  4. 在本地注册应用(用户运行此命令):

    xurl auth apps add my-app --client-id YOUR_CLIENT_ID --client-secret YOUR_CLIENT_SECRET
  5. 认证(指定 --app 以将令牌绑定到你的应用):

    xurl auth oauth2 --app my-app

    (这会打开浏览器以进行 OAuth 2.0 PKCE 流程。)

    如果 X 在 OAuth 后查找 /2/users/me 时返回 UsernameNotFound 错误或 403,请显式传递你的用户名(xurl v1.1.0+):

    xurl auth oauth2 --app my-app YOUR_USERNAME

    这会将令牌绑定到你的用户名,并跳过有问题的 /2/users/me 调用。

  6. 将应用设为默认应用,以便所有命令都使用它:

    xurl auth default my-app
  7. 验证:

    xurl auth status
    xurl whoami

完成此操作后,智能体即可使用以下任何命令,无需进一步设置。OAuth 2.0 令牌会自动刷新。

常见陷阱: 如果在 xurl auth oauth2 中省略 --app my-app,OAuth 令牌将保存到内置的 default 应用配置文件中 —— 该配置文件没有 client-id 或 client-secret。即使 OAuth 流程看似成功,命令也会因认证错误而失败。如果遇到此问题,请重新运行 xurl auth oauth2 --app my-appxurl auth default my-app


快速参考

操作命令
发帖xurl post "Hello world!"
回复xurl reply POST_ID "Nice post!"
引用xurl quote POST_ID "My take"
删除帖子xurl delete POST_ID
读取帖子xurl read POST_ID
搜索帖子xurl search "QUERY" -n 10
我是谁xurl whoami
查找用户xurl user @handle
主页时间线xurl timeline -n 20
提及xurl mentions -n 10
点赞 / 取消点赞xurl like POST_ID / xurl unlike POST_ID
转发 / 撤销转发xurl repost POST_ID / xurl unrepost POST_ID
收藏 / 取消收藏xurl bookmark POST_ID / xurl unbookmark POST_ID
列出收藏 / 点赞xurl bookmarks -n 10 / xurl likes -n 10
关注 / 取消关注xurl follow @handle / xurl unfollow @handle
正在关注 / 关注者xurl following -n 20 / xurl followers -n 20
屏蔽 / 取消屏蔽xurl block @handle / xurl unblock @handle
静音 / 取消静音xurl mute @handle / xurl unmute @handle
发送私信xurl dm @handle "message"
列出私信xurl dms -n 10
上传媒体xurl media upload path/to/file.mp4
媒体状态xurl media status MEDIA_ID
列出应用xurl auth apps list
移除应用xurl auth apps remove NAME
设置默认应用xurl auth default APP_NAME [USERNAME]
单次请求指定应用xurl --app NAME /2/users/me
认证状态xurl auth status

注意:

  • POST_ID 也接受完整 URL(例如 https://x.com/user/status/1234567890)—— xurl 会自动提取 ID。
  • 用户名可以带或不带前导 @

命令详情

发帖

xurl post "Hello world!"
xurl post "Check this out" --media-id MEDIA_ID
xurl post "Thread pics" --media-id 111 --media-id 222

xurl reply 1234567890 "Great point!"
xurl reply https://x.com/user/status/1234567890 "Agreed!"
xurl reply 1234567890 "Look at this" --media-id MEDIA_ID

xurl quote 1234567890 "Adding my thoughts"
xurl delete 1234567890

读取与搜索

xurl read 1234567890
xurl read https://x.com/user/status/1234567890

xurl search "golang"
xurl search "from:elonmusk" -n 20
xurl search "#buildinpublic lang:en" -n 15

用户、时间线、提及

xurl whoami
xurl user elonmusk
xurl user @XDevelopers

xurl timeline -n 25
xurl mentions -n 20

互动

xurl like 1234567890
xurl unlike 1234567890

xurl repost 1234567890
xurl unrepost 1234567890

xurl bookmark 1234567890
xurl unbookmark 1234567890

xurl bookmarks -n 20
xurl likes -n 20

社交图谱

xurl follow @XDevelopers
xurl unfollow @XDevelopers

xurl following -n 50
xurl followers -n 50

# 其他用户的图谱
xurl following --of elonmusk -n 20
xurl followers --of elonmusk -n 20

xurl block @spammer
xurl unblock @spammer
xurl mute @annoying
xurl unmute @annoying

私信

xurl dm @someuser "Hey, saw your post!"
xurl dms -n 25

媒体上传

# 自动检测类型
xurl media upload photo.jpg
xurl media upload video.mp4

# 显式指定类型/类别
xurl media upload --media-type image/jpeg --category tweet_image photo.jpg

# 视频需要服务器端处理 —— 检查状态(或轮询)
xurl media status MEDIA_ID
xurl media status --wait MEDIA_ID

# 完整工作流
xurl media upload meme.png # 返回 media id
xurl post "lol" --media-id MEDIA_ID

原始 API 访问

快捷命令涵盖了常见操作。对于其他任何操作,请使用针对任意 X API v2 端点的原始 curl 风格模式:

# GET
xurl /2/users/me

# POST 带 JSON 正文
xurl -X POST /2/tweets -d '{"text":"Hello world!"}'

# DELETE / PUT / PATCH
xurl -X DELETE /2/tweets/1234567890

# 自定义头部
xurl -H "Content-Type: application/json" /2/some/endpoint

# 强制流式传输
xurl -s /2/tweets/search/stream

# 完整 URL 也适用
xurl https://api.x.com/2/users/me

全局标志

标志缩写描述
--app使用特定已注册应用(覆盖默认值)
--auth强制认证类型:oauth1oauth2app
--username-u使用哪个 OAuth2 账户(如果存在多个)
--verbose-v禁止在智能体会话中使用 —— 会泄露认证头部
--trace-t添加 X-B3-Flags: 1 追踪头部

流式传输

流式端点会被自动检测。已知的包括:

  • /2/tweets/search/stream
  • /2/tweets/sample/stream
  • /2/tweets/sample10/stream

在任何端点上使用 -s 强制启用流式传输。


输出格式

所有命令均将 JSON 输出到 stdout。结构镜像 X API v2:

{ "data": { "id": "1234567890", "text": "Hello world!" } }

错误也是 JSON 格式:

{ "errors": [ { "message": "Not authorized", "code": 403 } ] }

常见工作流

发布带图片的帖子

xurl media upload photo.jpg
xurl post "Check out this photo!" --media-id MEDIA_ID

回复对话

xurl read https://x.com/user/status/1234567890
xurl reply 1234567890 "Here are my thoughts..."

搜索并互动

xurl search "topic of interest" -n 10
xurl like POST_ID_FROM_RESULTS
xurl reply POST_ID_FROM_RESULTS "Great point!"

检查你的活动

xurl whoami
xurl mentions -n 20
xurl timeline -n 20

多应用(凭据已手动预配置)

xurl auth default prod alice # prod 应用,alice 用户
xurl --app staging /2/users/me # 单次请求使用 staging 应用

错误处理

  • 任何错误都会返回非零退出码。
  • API 错误仍会以 JSON 格式打印到 stdout,因此你可以解析它们。
  • 身份验证错误 → 让用户在智能体会话外重新运行 xurl auth oauth2
  • 需要调用者用户 ID 的命令(例如 repost、bookmark、follow 等)将通过 /2/users/me 自动获取。该处的身份验证失败会显示为身份验证错误。

智能体工作流程

  1. 验证先决条件:xurl --helpxurl auth status
  2. 检查默认应用是否具有凭据。 解析 auth status 输出。默认应用标记为 。如果默认应用显示 oauth2: (none),但另一个应用具有有效的 oauth2 用户,请告诉用户运行 xurl auth default <that-app> 来修复它。这是最常见的设置错误 —— 用户添加了一个自定义名称的应用,但从未将其设置为默认应用,因此 xurl 会持续尝试使用空的 default 配置文件。
  3. 如果完全没有身份验证,请停止并引导用户查看“一次性用户设置”部分 —— 切勿尝试自行注册应用或传递密钥。
  4. 从一个低成本的读取操作开始(xurl whoamixurl user @handlexurl search ... -n 3)以确认可访问性。
  5. 在任何写入操作(发帖、回复、点赞、转发、私信、关注、屏蔽、删除)之前,请确认目标帖子/用户以及用户的意图。
  6. 直接使用 JSON 输出 —— 每个响应已经是结构化的。
  7. 切勿将 ~/.xurl 的内容粘贴回对话中。

故障排除

症状原因修复方法
OAuth 流程成功后出现身份验证错误令牌保存到了 default 应用(无 client-id/secret),而不是你命名的应用xurl auth oauth2 --app my-app,然后 xurl auth default my-app
OAuth 期间出现 unauthorized_client在 X 仪表板中将应用类型设置为“原生应用”在用户身份验证设置中更改为“Web 应用、自动化应用或机器人”
OAuth 后立即在 /2/users/me 上出现 UsernameNotFound 或 403X 无法从 /2/users/me 可靠地返回用户名重新运行 xurl auth oauth2 --app my-app YOUR_USERNAME(xurl v1.1.0+)以显式传递句柄
每个请求都返回 401令牌已过期或默认应用错误检查 xurl auth status —— 验证 是否指向具有 oauth2 令牌的应用
client-forbidden / client-not-enrolledX 平台注册问题仪表板 → 应用 → 管理 → 移至“按使用量付费”套餐 → 生产环境
CreditsDepletedX API 余额为 $0在开发者控制台 → 计费中购买积分(最低 $5)
图片上传时出现 media processing failed默认类别为 amplify_video添加 --category tweet_image --media-type image/png
X 仪表板中有两个“客户端密钥”值UI 错误 —— 第一个实际上是客户端 ID在“密钥和令牌”页面上确认;ID 以 MTpjaQ 结尾

注意事项

  • 速率限制: X 对每个端点实施速率限制。429 表示请等待并重试。写入端点(发帖、回复、点赞、转发)的限制比读取端点更严格。
  • 范围: OAuth 2.0 令牌使用宽泛的范围。特定操作上的 403 通常表示令牌缺少某个范围 —— 请用户重新运行 xurl auth oauth2
  • 令牌刷新: OAuth 2.0 令牌会自动刷新。无需执行任何操作。
  • 多个应用: 每个应用都有独立的凭据/令牌。使用 xurl auth default--app 进行切换。
  • 每个应用的多个账户: 使用 -u / --username 选择,或使用 xurl auth default APP USER 设置默认账户。
  • 令牌存储: ~/.xurl 是 YAML 格式。切勿将此文件读取或发送到 LLM 上下文。
  • 成本: 有意义的 X API 访问通常需要付费。许多失败是套餐/权限问题,而非代码问题。

归属信息