Octarq

快速开始

5 分钟内安装 Octarq 并与你的第一个 Agent 对话

安装

方式一:桌面应用 (Windows / macOS / Linux)

最新发布页 下载对应平台的安装包:

平台文件
Windows.msi 安装程序
macOS.dmg 磁盘镜像
Linux.AppImage.deb

桌面应用包含完整的 Octarq 系统,支持系统托盘、自动更新和桌面通知。

方式二:Shell 安装 (Linux / macOS)

curl -sSf https://octarq.jungley.net/install.sh | sh

方式三:PowerShell 安装 (Windows)

irm https://octarq.jungley.net/install.ps1 | iex

方式四:Cargo 安装

需要 Rust 1.75+:

cargo install --git https://github.com/Jungley8/Octarq openfang-cli

或从源码构建:

git clone https://github.com/Jungley8/Octarq.git
cd Octarq
cargo install --path crates/openfang-cli

方式五:Docker

docker pull ghcr.io/Jungley8/octarq:latest

docker run -d \
  --name octarq \
  -p 4200:4200 \
  -e ANTHROPIC_API_KEY=$ANTHROPIC_API_KEY \
  -v octarq-data:/data \
  ghcr.io/Jungley8/octarq:latest

验证安装

openfang --version

配置

初始化

openfang init

这会创建:

~/.openfang/
  config.toml    # 主配置文件
  data/          # 数据库和运行时数据
  agents/        # Agent 清单 (可选)

设置 API 密钥

openfang 需要至少一个 LLM 供应商的 API 密钥:

# Anthropic (Claude)
export ANTHROPIC_API_KEY=sk-ant-...

# 或 OpenAI
export OPENAI_API_KEY=sk-...

# 或 Groq (有免费套餐)
export GROQ_API_KEY=gsk_...

# 或 Gemini (有免费套餐)
export GEMINI_API_KEY=AIza...

将上述 export 命令添加到你的 shell 配置文件 (~/.zshrc, ~/.bashrc 等) 中以持久化。

验证配置

openfang doctor

启动 Agent

使用内置模板

openfang 内置 30 个 Agent 模板。启动 hello-world 示例:

openfang agent spawn agents/hello-world/agent.toml

与 Agent 对话

openfang chat hello-world

示例会话:

Chat session started. Type 'exit' or Ctrl+C to quit.

you> 你好!你能做什么?

agent> 我可以:
- 读取文件系统中的文件
- 列出目录内容
- 获取网页内容

试着让我读取一个文件或查找一些网上的信息!

  [tokens: 142 in / 87 out | iterations: 1]

启动守护进程

openfang dashboard

守护进程提供:

  • REST API http://127.0.0.1:4200/api/
  • WebSocket ws://127.0.0.1:4200/api/agents/{id}/ws
  • WebChat UI http://127.0.0.1:4200/

设置 TELOS

TELOS 是 Octarq 的灵魂。初始化你的个人目标档案:

openfang telos init

然后预览 Agent 将如何理解你的目标:

openfang telos preview researcher

详见 TELOS 目标系统


下一步

目录