跳转至

脚本

scripts/ 包含用于本地工作流和运维任务的辅助脚本。当任务明确对应某个脚本时,使用这些脚本。否则优先使用 CLI。

约定

  • 除非在文档或发布检查清单中引用,脚本是可选的。
  • 如果存在 CLI 界面,请优先使用 CLI 界面(示例:openclaw models status --check)。
  • 假定脚本是主机特定的。在新机器上运行前先阅读它们。

身份验证监控脚本

通用模型身份验证已在 身份验证 中介绍。以下脚本是一个独立的可选系统。它们监控远程/无头主机上的 Claude Code CLI 订阅 token。它们还允许你从手机重新身份验证:

  • scripts/setup-auth-system.sh - 一次性设置:检查当前身份验证,帮助生成长期有效的 claude setup-token,并打印 systemd/Termux 安装步骤。
  • scripts/claude-auth-status.sh [full|json|simple] - 检查 Claude Code + OpenClaw 身份验证状态。
  • scripts/auth-monitor.sh - 轮询状态,并在 token 接近过期时发送通知(通过 openclaw message send,和/或 ntfy.sh),包括在身份验证仍可用时的最后 1 小时。环境变量:WARN_HOURS(默认 2)、NOTIFY_PHONE、NOTIFY_NTFY。通过捆绑的 scripts/systemd/openclaw-auth-monitor.{service,timer} 按计划运行(每 30 分钟)。
  • scripts/mobile-reauth.sh - 重新运行 claude setup-token,并打印要在手机上打开的 URL,用于通过 Termux 的 SSH 使用。
  • scripts/termux-quick-auth.sh、scripts/termux-auth-widget.sh - Termux:Widget 脚本。它们 SSH 到主机并显示状态提示。当身份验证过期时,它们会打开重新身份验证控制台/说明。

要在 OpenClaw 中使用 Claude CLI 登录,请遵循 Claude CLI 复用。Claude 进程持有其登录凭据。

GitHub 读取助手

当你希望 gh 使用 GitHub App 安装 token 执行仓库范围的读取调用时,使用 scripts/gh-read。这样可让普通 gh 继续使用你的个人登录执行写入操作。

必需环境变量:

  • 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

添加脚本时

  • 保持脚本专注且有文档说明。
  • 在相关文档中添加简短条目(如果缺失则创建一个)。

本页原文 Markdown:在 AtomGit 查看·内容源自开源项目 cl/openclaw