openclacky

环境要求

• 可运行 Docker 的 Linux / macOS / Windows 环境（Windows 需 10 2004+ 或 Windows 11）
• 自备任意 OpenAI 兼容模型的 API Key（BYOK）
• 使用源码安装时需本机有 Ruby 与 Bundler 环境
• 能访问 ghcr.io 拉取容器镜像，或能访问官网下载桌面安装包

安装与启动步骤

1. 1选择安装方式

   README 提供桌面安装包与 Docker 两种方式。桌面版会自动装好环境、依赖与 Skills，新手优先选它。

2. 2下载桌面安装包

   从官方链接下载对应系统安装包，双击安装即可，无需手动配置环境与依赖。

3. 3Docker 运行(Linux)

   Linux 下必须加 --network=host，容器内 agent 才能连上宿主机 Chrome 的远程调试端口。

   docker run -d --name openclacky --network=host \
     -e CLACKY_ACCESS_KEY="" \
     -v openclacky-data:/root/.clacky \
     ghcr.io/clacky-ai/openclacky:latest

   复制

4. 4Docker 运行(Mac/Win)

   macOS/Windows 不支持 --network=host，改为映射 7070 端口，浏览器自动化能力可能受限。

   docker run -d --name openclacky -p 7070:7070 \
     -e CLACKY_ACCESS_KEY="" \
     -v openclacky-data:/root/.clacky \
     ghcr.io/clacky-ai/openclacky:latest

   复制

5. 5从源码安装

   克隆仓库、安装 Ruby 依赖后用 bin/clacky 启动，适合需要改代码的开发者。

   git clone https://github.com/clacky-ai/openclacky.git
   cd openclacky
   bundle install
   bin/clacky

   复制

6. 6配置模型与密钥

   启动后在交互界面输入 /config，填写 API Key、Model 和 Base URL，任一 OpenAI 兼容端点均可。

   openclacky
   /config

   复制

关键配置

如何确认成功

Docker 方式启动后浏览器打开 http://localhost:7070 能看到界面；源码方式运行 bin/clacky 后出现交互提示符并可执行 /config。

常见问题

注意事项

• 桌面安装包会自动完成环境、依赖与 Skills 配置，最省事，推荐普通用户使用。
• 容器方式的数据保存在 openclacky-data 卷中（对应容器内 /root/.clacky），删除容器不会丢失配置。
• README 中的镜像地址带有 <owner> 占位符，实际拉取前请以官网/仓库说明确认完整镜像名。
• 项目为 BYOK 模式，需自备模型 API Key，费用由所使用的模型服务商收取。