文档与帮助

快速上手 OKCode,解答常见疑问

安装与启动

Windows

下载页下载 .msi 安装包,双击运行,按提示完成安装。安装完成后在开始菜单或桌面找到 OKCode 图标启动。

💡 Windows 11 可能弹出"Windows 已保护您的电脑"提示,点击"更多信息" → "仍要运行"即可。这是因为应用尚未购买 EV 代码签名证书,安全性无问题。

macOS

下载 .dmg 文件,打开后将 OKCode 拖入 Applications 文件夹。首次启动时系统可能提示"无法验证开发者",进入 系统偏好设置 → 安全性与隐私,点击"仍要打开"即可。

初次使用

启动 OKCode 后,左侧侧边栏是工具导航区,点击对应图标切换功能模块。顶部 Tab 栏显示当前打开的所有工作区,可通过 + 按钮新建终端 Tab。

首次使用无需注册或激活,默认进入免费版。免费版可长期使用,主要限制项目数、连接数和部分高级能力;需要完整权益时再激活专业版。

终端

OKCode 内置完整 PTY 终端,支持所有常用 Shell(Bash、Zsh、Fish、PowerShell)。

常用操作

  • 新建终端 Tab:点击顶部 + 或快捷键 Ctrl+T
  • 分屏:在 Tab 内右键菜单选择"水平分屏" / "垂直分屏"
  • 关闭 Tab:点击 Tab 上的 ×Ctrl+W
  • 调整字体大小:设置 → 终端 → 字体大小

SSH 管理

在左侧侧边栏点击 SSH 图标进入 SSH 管理面板,可以保存和管理多个远程服务器连接。

添加连接

  • 点击"+"新增连接,填写主机、端口、用户名
  • 认证方式支持密码和 SSH 密钥文件(.pem / .key
  • 支持跳板机(Jump Host)配置
💡 SSH 密钥推荐使用 Ed25519 格式,安全性更高。

数据库管理

支持 MySQL、PostgreSQL、SQLite、SQL Server、MongoDB 和 Redis,可通过 SSH 隧道连接内网数据库。

连接数据库

  • 左侧数据库图标 → "新建连接" → 选择数据库类型
  • 填写连接信息后点击"测试连接"验证
  • 支持 SSL / TLS 加密连接
  • 支持 SSH 隧道(跳过防火墙访问内网库)

查询编辑器

内置 SQL 编辑器,支持语法高亮、自动补全。可通过内置 AI 助手辅助编写复杂 SQL。

Git 可视化

在本地项目面板中选择 Git 仓库,可以可视化查看提交历史、管理分支、进行暂存区操作。

  • 查看 diff:点击文件名查看改动详情
  • 提交:填写 commit message 后点击提交按钮
  • 推送/拉取:工具栏按钮一键操作

HTTP 客户端

轻量级 API 调试工具,底层通过 Rust 的 reqwest 发送请求,绕过 WebView CORS 限制,可以直接请求任意接口。

  • 支持 GET / POST / PUT / DELETE / PATCH 等所有方法
  • 支持自定义 Header 和 Body(JSON、Form、Raw)
  • 响应结果支持 JSON 格式化查看

Claude AI 集成

内置 Claude AI 对话面板,需要在 设置 → AI 设置 中配置 API Key 和 API 地址。

支持的 API

  • Anthropic 官方 API(claude.ai API Key)
  • OpenAI 兼容 API(任意 OpenAI 格式的代理或本地模型)

Claude Code 会话管理

如果你使用 Claude Code CLI,OKCode 可以浏览和恢复历史 Claude Code 会话,在终端中直接 --resume 继续之前的对话。

授权激活

购买专业版授权码后,在 OKCode 中激活:

  • 打开 设置(左下角齿轮图标)
  • 选择左侧 授权 分类
  • 输入授权码(XXXX-XXXX-XXXX-XXXX 格式)和购买时使用的邮箱
  • 点击"激活",联网验证后立即生效
⚠ 激活需要网络连接,激活成功后离线也能使用。如遇网络问题请检查防火墙设置。

如需购买授权码,请联系 support@okcode.cn

常见问题

终端颜色/字体不对怎么办?
进入设置 → 终端,可以调整字体、字号、主题配色。如果终端颜色显示异常,检查 TERM 环境变量是否设置为 xterm-256color。
SSH 连接断开后无法重连?
在 SSH 连接设置中开启"保活(Keepalive)"选项,并将 ServerAliveInterval 设置为 30 秒。如果服务端有 ClientAliveInterval 限制,需要联系服务器管理员调整。
数据库连接超时?
检查服务器防火墙是否放开对应端口(MySQL 3306、PostgreSQL 5432 等)。如果数据库在内网,需要配置 SSH 隧道连接。
macOS 提示"应用已损坏"?
在终端中运行:sudo xattr -r -d com.apple.quarantine /Applications/OKCode.app,然后重新打开即可。
如何导出/备份我的配置?
所有配置数据存储在系统的 App Data 目录中(Windows: %APPDATA%\com.okcode.app,macOS: ~/Library/Application Support/com.okcode.app),直接备份该目录即可。
卸载后数据会丢失吗?
卸载程序不会自动删除配置数据,重新安装后数据依然存在。如需彻底清除,手动删除上述 App Data 目录即可。
没找到答案?
在 Gitee 提交 Issue 或发送邮件联系我们