Skip to main content

Web-aware Tool CLI - 支持 ReAct、Plan-and-Execute、Memory、RAG、Multi-Agent、HITL

Project description

Vox Code

一个面向开发工作流的 AI CLI,带有桌宠 GUI、工具调用、记忆、RAG 和多运行模式。

Vox Code 试图把“能聊天的模型”变成“能在本地开发环境里协作的助手”。
它既可以作为纯终端工具使用,也可以作为桌面编程搭子运行。

当前版本:2.0.1

Highlights

  • vox-code:终端交互式 AI CLI
  • vox-pet:基于 PySide6 的桌宠 GUI
  • 支持 GLMDeepSeekQwen APIOllama
  • 支持 /model 动态切换模型
  • 支持 single / plan / team 三种运行模式
  • 内置工具调用、代码检索、Memory、RAG、HITL、安全策略和审计日志
  • 配置与源码分离,支持 .env、环境变量和用户目录配置

Why Vox Code

和普通的聊天壳不一样,Vox Code 更偏向“本地开发协作工具”:

  • 不只关心对话,还关心项目上下文、命令执行和代码检索
  • 不把模型绑定死在单一厂商,支持云端和本地模型混用
  • 同时提供 CLI 和桌宠 GUI,两套交互风格可以共存
  • 适合作为个人 AI Coding Assistant 的实验场和产品原型

Quick Start

Requirements

  • Python 3.11+

1. Install

CLI only:

pip install -e .

With GUI:

pip install -e ".[gui]"

2. Init Config

推荐先运行:

vox-code init

它会引导你填写:

  • provider
  • model
  • base URL
  • API key

也可以手动写 .env 或环境变量,示例见 .env.example

3. Start CLI

vox-code

4. Start Desktop Pet

vox-pet

也支持模块方式启动:

python -m voxcli
python -m voxcli.gui

Supported Providers

当前正式支持的 provider:

Provider Mode Default Model
glm Cloud API glm-5.1
deepseek Cloud API deepseek-chat
qwen Cloud API qwen-plus
ollama Local Model qwen2.5:7b

说明:

  • qwen 支持 QWEN_* 变量名
  • 同时兼容阿里云 DASHSCOPE_* 变量名
  • ollama 适合本地模型和离线/低成本场景

Configuration

Config Priority

配置按下面优先级读取:

  1. 环境变量
  2. .env
  3. ~/.vox-code/config.json

默认配置目录:

  • macOS / Linux: ~/.vox-code/config.json
  • Windows: %USERPROFILE%\.vox-code\config.json

也支持自定义目录:

  • VOX_CODE_HOME
  • VOX_HOME

Example: GLM

export GLM_API_KEY="your_key"
export GLM_MODEL="glm-5.1"
export GLM_BASE_URL="https://open.bigmodel.cn/api/paas/v4/chat/completions"
vox-code

Example: DeepSeek

export DEEPSEEK_API_KEY="your_key"
export DEEPSEEK_MODEL="deepseek-chat"
export DEEPSEEK_BASE_URL="https://api.deepseek.com/chat/completions"
vox-code

Example: Qwen

export QWEN_API_KEY="your_key"
export QWEN_MODEL="qwen-plus"
export QWEN_BASE_URL="https://dashscope.aliyuncs.com/compatible-mode/v1"
vox-code

兼容 DashScope 命名:

export DASHSCOPE_API_KEY="your_key"
export DASHSCOPE_MODEL="qwen-plus"
export DASHSCOPE_BASE_URL="https://dashscope.aliyuncs.com/compatible-mode/v1"
vox-code

Example: Ollama

export OLLAMA_MODEL="qwen2.5:7b"
export OLLAMA_BASE_URL="http://localhost:11434"
vox-code

Common Commands

Command Description
vox-code init 初始化模型配置
vox-code config-path 查看配置文件路径
/model <preset-id|provider[:model]> 切换模型
/team 切换运行模式
/style <work|pet> 切换展示风格
/memory 查看记忆状态
/policy 查看安全策略
/audit 查看最近审计日志

Desktop GUI

vox-pet 会启动桌宠界面,适合偏轻量、陪伴式的交互方式。

GUI 当前支持:

  • 跟随全局 CLI 配置
  • 独立 GUI 模型配置
  • OpenAI Compatible 网关
  • Qwen API 标签显示

如果 PySide6 不可用,GUI 无法启动,但 CLI 仍可正常使用。

如果你要把 GUI 一起装上:

pip install "vox-code[gui]"

Project Layout

voxcli/
├── agent/       # Agent、Plan-and-Execute、多 Agent 协作
├── cli/         # CLI 入口与命令解析
├── config.py    # 配置读取与持久化
├── gui/         # 桌宠 GUI
├── hitl/        # 人工审批与交互控制
├── llm/         # 模型接入层
├── memory/      # 长短期记忆
├── rag/         # 索引、切块、检索、嵌入
├── runtime/     # 会话控制器
├── tool/        # 工具注册与调用
└── web/         # Web 搜索与抓取

Development

常用开发命令:

vox-code
vox-pet
vox-code config-path

如果你想快速验证配置是否生效,推荐先跑:

vox-code init

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vox_code-2.0.4.tar.gz (120.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

vox_code-2.0.4-py3-none-any.whl (158.3 kB view details)

Uploaded Python 3

File details

Details for the file vox_code-2.0.4.tar.gz.

File metadata

  • Download URL: vox_code-2.0.4.tar.gz
  • Upload date:
  • Size: 120.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for vox_code-2.0.4.tar.gz
Algorithm Hash digest
SHA256 4addbaf95222dfc9168a230b88941820c1cb44c7bf821907bb3ed5598ede3912
MD5 849458d2a5576b2f9148459f96ee7093
BLAKE2b-256 3574f68f76fffdc28b389b71ea5bc83c196ad26783c3dff5a1c3ceff41e319bc

See more details on using hashes here.

Provenance

The following attestation bundles were made for vox_code-2.0.4.tar.gz:

Publisher: pypi-publish.yml on faliang1129/vox-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file vox_code-2.0.4-py3-none-any.whl.

File metadata

  • Download URL: vox_code-2.0.4-py3-none-any.whl
  • Upload date:
  • Size: 158.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for vox_code-2.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 c6e7aa6db921a87b945e83da154686f46724f810c62e23b2e1839750999bdd37
MD5 03b0b2bd015afd39940e48caa148ec52
BLAKE2b-256 1b7c5453b7492daf5f1c8aa6bbbf3192989bc8b4fd49da85f3f77b436092f088

See more details on using hashes here.

Provenance

The following attestation bundles were made for vox_code-2.0.4-py3-none-any.whl:

Publisher: pypi-publish.yml on faliang1129/vox-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page