个性化版安装与初始化

Vyane 是一个 Python 项目,依赖和虚拟环境统一用 uv 管理(uv 是 Rust 写的包管理器,可以理解成"更快的 pip + venv 一体机")。装好依赖后,跑一次交互式向导生成配置,再用一条命令验证哪些模型能用,就可以开始派任务了。

这是个性化版安装方式

本页保留迁移期间的个性化版本安装方式。Vyane 开源版使用 Rust 实现,请从 vyane-rs README 获取当前安装与运行步骤。

本页只讲从零到能跑通的三步:装依赖 → 初始化配置 → 验证可用性。命令怎么用见快速上手。

前置要求

Python 3.10 及以上(项目要求 requires-python >= 3.10)。
uv。没装的话按 uv 官方文档装,一行命令即可。
至少一个可用的 provider。provider 指"谁给你 endpoint / key / 额度",可以是本机装好的 CLI(如 Codex CLI、Claude Code),也可以是配了 API key 的云端模型服务。一个都没有也能先生成配置、之后再补。

第一步:装依赖

在仓库根目录跑:

uv sync

uv sync 会读 pyproject.toml 和锁文件,创建虚拟环境并把依赖装齐。之后所有 Vyane 命令都以 uv run vyane 开头,uv 会自动用这个环境跑,不用手动 activate。

验证装好了:

uv run vyane --help

能打印出命令列表就说明依赖就位了。

第二步:初始化配置(vyane init)

uv run vyane init

vyane init 是一个交互式向导,一步步问你几个问题,最后在 ~/.config/vyane/ 下生成配置文件。它会:

探测本机 provider —— 自动检查 Codex CLI、Claude Code 的 binary 是否在 PATH 里,以及云端 provider 的 API key 环境变量是否已设。找到的标 found,没找到的给出安装提示。
选默认 provider —— 当你用 provider="auto" 智能路由、但没有关键词命中时,该走哪个模型兜底。
自定义路由规则(可选) —— 按关键词把任务路由到指定 provider,例如"含'算法'的任务走 Codex"。
命名 profile(可选) —— profile 是一组命名好的 provider / 模型组合,例如建一个 budget profile 专用便宜模型。
安全策略(可选) —— 每小时 / 每天调用上限、是否禁用 full 沙箱等级等。
选保存位置 —— 用户级(~/.config/vyane/)还是项目级(当前目录的 .vyane/)。

向导跑完会生成:

文件	内容	何时生成
`~/.config/vyane/profiles.toml`	默认 provider、路由规则、profile 定义	每次都生成
`~/.config/vyane/policy.json`	速率限制与沙箱策略	只有你在第 5 步配了策略才生成

scope 参数

默认交互时会问你存哪。想跳过提问直接指定,加 --scope:uv run vyane init --scope user(用户级)或 --scope project(项目级,写到当前目录 .vyane/)。默认是 auto(向导里再问)。

init 不管 API key —— secrets.env 要手动建

vyane init 只生成 profiles.toml,不会帮你写 API key 或 token。密钥类配置放在单独的 ~/.config/vyane/secrets.env 里,需要你手动建(见下一节)。这样做是为了把"选型配置"和"敏感密钥"分开管理。

配 API key:secrets.env

云端 provider 靠环境变量里的 API key 认证。Vyane 在启动时会主动读取 ~/.config/vyane/secrets.env 并把里面的键注入环境——这样即使 Vyane 被 MCP 客户端(如 Claude Code 桌面端)拉起、拿不到你 shell 里 export 的变量,key 也不会丢。

仓库根目录有一份模板 .env.example,照着建即可:

mkdir -p ~/.config/vyane
cp .env.example ~/.config/vyane/secrets.env
chmod 600 ~/.config/vyane/secrets.env

然后编辑 ~/.config/vyane/secrets.env,把用到的 key 填进去。每个云端 provider 对应一个环境变量名(具体变量名看 .env.example 模板),例如:

YOUR_PROVIDER_API_KEY=你的-key

别把 key 放项目里的 .env

出于安全考虑,Vyane 只读 ~/.config/vyane/secrets.env(或你用 $VYANE_ENV_FILE 显式指定的路径),从不读当前工作目录的 .env——避免一个不可信的项目 checkout 通过自带 .env 劫持你的 provider key 或 base URL。

第三步:验证 provider 可用性(vyane check)

uv run vyane check

vyane check 不需要起 MCP 服务,直接扫一遍每个 adapter:

binary 类 provider(codex / claude / opencode 等)—— 看对应命令是否在 PATH 里,可用的话打印出 binary 路径。
API key 类 provider(各云端模型服务)—— 看对应 key 是否读到了(会一并读 secrets.env)。

输出里 [+] 表示可用、[-] 表示没找到,末尾还会带上当前 profile、路由规则数量,以及最近 24 小时的派单统计。想让脚本 / CI 消费,加 --json:

uv run vyane check --json

没有任何 provider 可用怎么办

check 全是 [-] 说明既没装本机 CLI、也没配 API key。按 vyane init 探测阶段给出的安装提示装一个 CLI,或在 secrets.env 里补一个云端 provider 的 key,再跑一次 check 确认变成 [+]。

改配置的两种方式

装好之后想调整配置,不用重头跑向导:

直接编辑 ~/.config/vyane/profiles.toml(TOML 文本,改完保存即可)。
或用 TUI 配置面板:uv run vyane config(需要 textual 包;命令会提示怎么装)。

一分钟跑通(汇总)

# 1. 装依赖
uv sync

# 2. 生成配置(交互式向导)
uv run vyane init

# 3.(可选)配 API key
cp .env.example ~/.config/vyane/secrets.env
chmod 600 ~/.config/vyane/secrets.env
# 编辑填入各 provider 的 API key

# 4. 验证哪些 provider 可用
uv run vyane check

check 里看到至少一个 [+],就可以去快速上手派第一个任务了。