Skip to content

2221186349/openclaw-quick-config-tool

Repository files navigation

OpenClaw 快速配置工具

这是一个支持图形界面和命令行的 OpenClaw 配置工具。

文件说明

  • openclaw_quick_config.py:命令行工具(CLI)
  • openclaw_quick_config_gui.py:图形界面(GUI)
  • start_gui.command:macOS 双击启动
  • start_gui.sh:Linux/macOS 终端启动
  • start_gui.bat:Windows 双击启动
  • build_release.py:跨平台打包脚本
  • build_release.sh:Linux/macOS 打包入口
  • build_release.bat:Windows 打包入口

主要功能

  • 图形化管理 Provider/Model,快速切换默认模型
  • 内置“新增模型向导”(三步填写,自动回填并保存)
  • 内置“指令复制区”(支持分类筛选,按当前模型动态生成常用命令,一键复制)
  • 内置“模型测试面板”(真实请求验证,不只看 probe)
  • 内置“网关状态监听”(自动监听、后台持久化启动、当前窗口启动、关闭网关)
  • 保留命令行能力,方便自动化脚本
  • 写入前自动备份配置(openclaw.json.bak.YYYYMMDD-HHMMSS
  • 可选重启网关和模型可用性探测

运行环境

  • Python 3
  • Tkinter(GUI 需要)
  • openclaw 命令可用(重启网关/探测时需要)

安全说明(重要)

  • 请不要把真实 apiKey、网关 token 或任何密钥提交到仓库。
  • 示例中的 sk-xxxxx 仅为占位符。
  • 建议通过本地配置文件或环境变量(如 OPENCLAW_BIN)管理敏感信息与路径。

GUI 使用

macOS

  • 双击 start_gui.command
  • 或终端执行:
./start_gui.sh

更推荐使用一键脚本:

  • 双击 launch_app.command:启动工具
  • 双击 build_app.command:重新编译并覆盖桌面 OpenClaw配置工具.app

也可以终端执行:

./manage_app.sh start
./manage_app.sh build

向导入口:在主界面点击 新增模型向导 按钮,按 3 步填写后点 完成并保存

Linux

./start_gui.sh

Windows

  • 双击 start_gui.bat
  • 或终端执行:
python openclaw_quick_config_gui.py

打包独立应用(GUI + CLI)

先安装 PyInstaller:

python3 -m pip install pyinstaller

macOS/Linux 打包:

./build_release.sh --clean

如果当前 Python 没有 Tk 支持,只打包 CLI:

./build_release.sh --clean --skip-gui

Windows 打包:

build_release.bat --clean

打包产物:

  • macOS GUI:dist/OpenClawQuickConfig.app
  • Linux GUI:dist/OpenClawQuickConfig/OpenClawQuickConfig
  • Windows GUI:dist/OpenClawQuickConfig/OpenClawQuickConfig.exe
  • CLI:dist/openclaw-quick-config/(不同系统可执行文件名会不同)

GitHub Releases 自动构建

仓库内置工作流:.github/workflows/release.yml

  • 触发方式:
    • 推送标签:v*(例如 v0.1.0
    • 手动触发:workflow_dispatch(填写 tag)
  • 产物:自动构建 macOS / Windows / Linux 的 GUI + CLI 包并上传到 GitHub Releases

Release 产物校验(推荐)

Release 会额外上传 SHA256SUMS.txt,用于校验下载文件完整性。

macOS / Linux:

shasum -a 256 -c SHA256SUMS.txt

Windows PowerShell:

Get-Content .\SHA256SUMS.txt | ForEach-Object {
  $parts = $_ -split "\s+", 2
  $expected = $parts[0]
  $file = $parts[1].Trim()
  $actual = (Get-FileHash $file -Algorithm SHA256).Hash.ToLower()
  if ($actual -ne $expected.ToLower()) {
    Write-Error "Checksum mismatch: $file"
  } else {
    Write-Host "OK: $file"
  }
}

Release 构建排错

  • Windows 任务里如果用到了 heredoc(如 python - <<'PY'),请确保步骤指定 shell: bash
  • Linux 需安装 python3-tk 才能打包 GUI(工作流中已自动安装)。
  • 如果只想生成 CLI,可在本地打包时加 --skip-gui

CLI 使用

查看当前 Provider 和默认模型:

python3 openclaw_quick_config.py show

设置默认模型:

python3 openclaw_quick_config.py set-primary --model-ref cdks/glm-5

快速新增或更新 Provider + Model:

python3 openclaw_quick_config.py quick-add \
  --provider-id cdks \
  --base-url https://v1.cdks.work/v1 \
  --api openai-completions \
  --api-key 'sk-xxxxx' \
  --model-id glm-5 \
  --model-name glm-5 \
  --input text,image \
  --context-window 200000 \
  --max-tokens 131072 \
  --reasoning false \
  --set-primary \
  --restart-gateway \
  --probe

仅预览,不写入:

python3 openclaw_quick_config.py quick-add ... --dry-run

备注

  • 默认配置路径:~/.openclaw/openclaw.json
  • CLI 使用原子写入,且每次都会创建时间戳备份
  • GUI 底层调用同一个 CLI 脚本,行为一致
  • 打包时会把 openclaw_quick_config.py 一并放进 GUI 包内,保证打包后 GUI 仍可执行配置操作

About

OpenClaw model/provider quick config GUI and CLI with gateway monitor and cross-platform release workflow

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors