Skip to main content

Documentation Index

Fetch the complete documentation index at: https://openclaw.zhcndoc.com/llms.txt

Use this file to discover all available pages before exploring further.

scripts/ 目录包含用于本地工作流和运维任务的辅助脚本。 当某个任务明确与某个脚本相关时使用这些脚本;否则优先使用 CLI。

约定

  • 脚本是可选的,除非文档或发布检查清单中引用了它们。
  • 优先使用已存在的 CLI 接口(例如:身份验证监控使用 openclaw models status --check)。
  • 假设脚本具有主机特定性;在新机器上运行前先阅读它们。

身份验证监控脚本

身份验证监控在 Authentication 中有说明。scripts/ 下的脚本是用于 systemd/Termux 手机工作流的可选补充。

GitHub 读取辅助脚本

当你希望 gh 使用 GitHub App 安装令牌执行仓库范围内的读取调用,同时让正常的 gh 保持使用你的个人登录进行写入操作时,请使用 scripts/gh-read 必需的环境变量:
  • OPENCLAW_GH_READ_APP_ID
  • OPENCLAW_GH_READ_PRIVATE_KEY_FILE
可选的环境变量:
  • OPENCLAW_GH_READ_INSTALLATION_ID:当你想跳过基于仓库的安装查找时使用
  • OPENCLAW_GH_READ_PERMISSIONS:以逗号分隔的方式覆盖要请求的读取权限子集
仓库解析顺序:
  • gh ... -R owner/repo
  • GH_REPO
  • git remote origin
示例:
  • scripts/gh-read pr view 123
  • scripts/gh-read run list -R openclaw/openclaw
  • scripts/gh-read api repos/openclaw/openclaw/pulls/123

添加脚本时

  • 保持脚本聚焦且有文档说明。
  • 在相关文档中添加一条简短条目(如果缺失则新建一份)。

相关内容