AVL Code 参考手册

适用版本:AVL Code v0.6.13-alpha 及以上 适用平台:Windows · macOS · Linux 文档定位:以查询为目的、表格密集型的参考手册。每章按主题组织,按字段或键名罗列细节,便于在使用过程中按需翻查。

与配套手册的关系:日常使用请阅《AVL Code 用户手册》;初次安装请阅《AVL Code 快速上手指南》;本手册为前两者提供穷举式补充。


目录

  1. 总览
  2. 工作模式参考
  3. 设置面板参考
  4. 键盘快捷键参考
  5. 输入框 Slash 命令参考
  6. 随行通讯命令参考
  7. 智能编程工具参考
  8. 安全分析工具参考
  9. 外部工具服务接入参考
  10. 工具权限策略参考
  11. 计划与待办状态参考
  12. 技能(SKILL.md)格式参考
  13. 助手人设参考
  14. 模型 Provider 参考
  15. 历史折叠(Compact)参考
  16. 子任务与后台执行参考
  17. 命令行入口参考
  18. 主题与外观参考
  19. 系统集成参考
  20. 状态指示与提示参考
  21. 错误信息参考
  22. 数据与备份参考
  23. 文件命名约定
  24. 网络访问清单
  25. 隐私与遥测参考
  26. 升级与版本号参考
  27. 附录 A:术语表
  28. 附录 B:参数取值速查
  29. 附录 C:常见正则与通配符语法
  30. 附录 D:键值清单导出格式

1. 总览

本章给出"哪些东西可被查询"的总图,便于跳转到具体章节。

1.1 查询入口对照

你想查 章节
某个工作模式做什么 / 不做什么 第 2 章 工作模式
某个设置项在哪 / 默认值 第 3 章 设置面板
某个键盘快捷键 第 4 章 键盘快捷键
某个 /-开头命令的语义 第 5 / 6 章 Slash 命令
某个工具的参数 第 7 / 8 / 9 章 工具
某个权限策略生效顺序 第 10 章 权限
计划 / 待办的状态机 第 11 章
SKILL.md 的字段 第 12 章
助手人设字段 第 13 章
模型 / Provider 配置字段 第 14 章
一段命令行能做什么 第 17 章 CLI
应用主题色 / 间距 第 18 章
自启 / 托盘 / 通知 第 19 章
一个状态点 / 颜色含义 第 20 章
一段错误信息含义 第 21 章
备份 / 数据目录结构 第 22 章
文件命名规则 第 23 章
应用会访问哪些网络资源 第 24 章
隐私 / 遥测 第 25 章
升级源 / 版本号语义 第 26 章

1.2 阅读约定

  • 表格中 表示"无 / 不适用"。
  • 表格中 表示"省略,可参阅展开章节"。
  • 单元格里的 code 等宽内容代表字面字符串(命令、字段名、文件名、正则、shell 等)。
  • 「占位 ID」用 <…> 表示,例如 <workspace-id>
  • 「模式」列出现 表示该项不受工作模式影响。

2. 工作模式参考

2.1 模式一览

模式 图标 中文名 默认助手 写文件 编辑 终端执行 联网
auto 自动 内置 · 自动 启用 启用 启用 启用
plan 筹划 内置 · 筹划 禁用 禁用 禁用 启用
prepare 准备 内置 · 准备 启用 启用 启用 启用
execute 执行 内置 · 执行 启用 启用 启用 启用
assess 评估 内置 · 评估 禁用 禁用 禁用 启用

planassess只读模式,写入与终端执行类工具被强制禁用(fs.write / fs.patch / fs.exec / fs.exec.start / fs.exec.kill / git.init);fs.exec.tail / fs.exec.list / fs.glob / fs.grep 是只读操作仍可用。该约束作用于工具层,配置面板无法解除。

2.2 模式切换的副作用

切换发生时 行为
加载该模式绑定的助手 助手 SOUL 注入到下一回合
切换工具开关集合 工具列表立即重算可见性
在会话流中插入分隔标记 一条「模式切换」事件卡片
计划与待办 不重置;继承自上一模式
模型与参数 切到该模式记录的覆盖项;无覆盖时沿用工作区默认

2.3 推荐工作流

plan → prepare → execute → assess

各模式间的"退出"按钮显示在会话顶端横幅;点击会自动加载下一模式并把已确认产物(计划 / 准备清单 / 执行变更)注入新一回合。


3. 设置面板参考

设置面板共 14 个 tab,分为 3 个分组(账号 / 桌面 / 服务)。下表按界面顺序逐一列出,并标注作用粒度(G 全局 / W 工作区 / M 模式)与默认值。

3.0 设置面板分组

分组 包含的 tab
账号 账号
桌面 通用 · 最近工作区 · 数据 · 记忆宫殿 · 上下文
服务 提供商 · 模型 · 插件 · Hooks · Agents · 技能 · 随行通讯 · 例行程序

3.1 设置 → 账号

粒度 默认 说明
登录方式 G 手机号验证码 手机号验证码(默认;无账号自动注册;60s 倒计时;风控时切图形验证码)/ 用户名密码 / SSO
共享额度 G 自动 登录后自动下发;无需手动配置
点数余额提醒阈值 G 1 小时 离过期不到该时长,状态点变琥珀;面板前缀 §(点)
用量周期 G 24h / 7d / 30d 每分钟刷新
退出登录 G 点击执行;保留本地数据
兑换码 G 输入兑换码 → 就地反馈(成功 / 失效 / 已用过等 12 种本地化提示)
我的代金券 G 列出全部代金券:面额、有效期、永久券标注

3.2 设置 → 通用

粒度 默认 说明
语言 G 跟随系统 中文 / English
主题 G system system / light / dark
最小化到托盘 G 关窗后驻留托盘
开机自启 G 启动时静默到托盘
字体大小 G 小 / 中 / 大
记住窗口状态 G 关闭后启动用屏幕自适应默认尺寸并居中、退出不回写
配置目录 G 一键打开
检查更新 G 启用 手动 / 自动

3.3 设置 → 最近工作区(独立 Tab)

粒度 默认 说明
搜索 命中词高亮;始终显示
置顶区 / 其他区 各自独立滚动;置顶项不随下方滚动消失
多选 支持顶部批量操作栏(删除 / 打开)
删除 inline 倒计时 武装 → 3 秒倒计时 → 确认;不弹 confirm

3.4 设置 → 数据

粒度 默认 说明
存储占用视图 G 14 备份类别 + 6 非备份项,按 du 字节级对齐
单项 / 批量清理 G 含敏感数据的类别自动落 auto-clean-<ts> 快照
全量重置 G 深度清 14 类 + 重置默认配置 + 落 auto-fullreset-<ts> 快照
创建备份 G .zbk 加密文件(AES-GCM),14 类应用数据
恢复备份 G .zbk → 输入密码 → 预览 → 确认
历史快照 G 列出所有自动 / 手动快照,深链可跳定位
附件 / 样本上限 G 300 MiB 范围 1–4096 MiB;有「恢复默认」按钮
数据目录 G 一键打开备份 / 迁移用
同步(实验性) G 多设备共享

3.5 设置 → 上下文

粒度 默认 说明
会话自动重命名 G 未手动改名的会话首条 AI 回复后自动起标题
自动命名豁免 自动 手动改名过的会话永久豁免
历史折叠(Compact)阈值 G 由模型决定 接近 context 上限时触发

3.6 设置 → 记忆宫殿

粒度 默认 说明
记忆条目 G 长期记忆库的增删改查
旅程设计 G 把一组记忆组合成"旅程"
回顾面板 G 按主题查看历史回忆
单次提取上限 G 7 1–10 为固定上限;填 0 或 >10 则不设上限、由模型自主决定。自动 / 手动 / 重新提取三条路径统一生效

3.7 设置 → 提供商

粒度 默认 说明
Provider 列表 G AVL-Zero(共享,Delta) 可加自定义 Provider
类型 G AVL-Zero 默认 AVL Delta 兼容,其它默认 OpenAI AVL Delta 兼容 / OpenAI(兼容)/ Anthropicx-api-key + anthropic-version
Delta 协议开关 G 开(AVL-Zero) 每轮只传增量;404/405/501 本会话一次性回退 chat/completions,401/403 不降级
添加 / 编辑 G 名称 / 接入地址 / 凭证
API Key 管理 G 自动下发 自行接入时填写
模型刷新 G 立即按所选类型拉取模型列表

3.8 设置 → 模型

粒度 默认 说明
模型作用域 G 全局一致 全局一致(共用) / 跟随会话(独立,新建快照当前选择,失效自动回落)
未开启模型折叠 G 折叠 每个供应商分组默认只显示已开启的;底部「展开 N 个」一键展开,按供应商各自记忆;搜索自动绕过折叠
默认模型 W 由 Provider 决定 工作区粒度覆盖
Temperature W·M 0.7 0–1
Top-P W·M 1.0 0–1
最大输出 token W·M 4096 取决于模型上限
调用超时 G 30 秒 LLM 单次调用超时
最大迭代 W·M 0(无限) 单回合工具调用回合数上限
流式 G 关闭后整段输出

3.9 设置 → 插件

粒度 默认 说明
已安装列表 G 启用 / 禁用 / 卸载
浏览市场 G 默认市场 可加内部市场源
权限设置 G 询问 插件可调用的工具范围
自动更新 G 询问 启动时检查

3.10 设置 → Hooks

粒度 默认 说明
工具调用前确认 W·M 见各工具 三态:启用 / 询问 / 禁用
自动批准列表 W 「始终允许」写入此处
工具黑名单 W·M 强制禁用某些工具
错误抽屉 W 自动保留最近 100 条

3.11 设置 → Agents

粒度 默认 说明
Agent 列表 G 5 个内置 + 用户自定义 来源标签:内置 / 全局 / 工作区
名称 G 内置名 显示用
个性 G 内置 短句风格
系统提示词 G 内置 可指向工作区下文件
模式绑定 W 默认对应 五种模式各自指派一位
编辑 / 复制 / 删除 G 仅全局 / 工作区来源可编辑

3.12 设置 → 技能

粒度 默认 说明
技能列表 G + W 内置技能空 三层来源(全局 / 工作区 / 插件)
加载策略 W 自动 启动时刷新
签名校验 G 推荐开启 验签失败拒绝执行
自签证书 G 可生成国密自签
安装 / 删除 G 拖入文件夹或扫描目录

3.13 设置 → 例行程序

粒度 默认 说明
列表 G 按来源工作区分组
启停开关 G 与其它设置页同款 ui/Switch
立即运行 G 不等计划,立刻跑一轮
最近运行痕迹 G 行内展开,可逐条查看会话
跨工作区分组 G 未打开工作区显示徽标 + 一键打开
搜索 G 按例行程序名或工作区名

调度参数:

字段 类型 默认 说明
type enum manual daily / weekday / weekly / manual
weekdays array [1..7];预设「工作日」/「周末」一键
hour / minute int 时 / 分双列下拉(选中居中、选完分钟自动收起)
command string 触发时发给 AI 的指令内容
mode string auto 与正常会话同款五种模式
model string 与正常会话同款选择器(搜索分组)

运行行为:

  • 每次运行在对应工作区生成正常会话,过程与结果可回看。
  • 同一条例行程序运行中自动跳过下一次触发,不会叠跑。
  • 手动模式(无计划)保存后立即触发一轮,按钮显示「运行一次」。

3.14 设置 → 随行通讯

粒度 默认 说明
通道 G 微信 同时支持微信 / 飞书 / 钉钉
扫码登录 G 各通道独立扫码
配对码 W 6 位数字 10 分钟 TTL
工作区路由 W 默认会话 见 §6.2
节流 G min 200 / idle 3s / max 3800 字数控制
解绑 W 立即失效

4. 键盘快捷键参考

当前版本只列已绑定到键盘的快捷键。其它操作均通过界面按钮 / 右键菜单 / 命令面板(输入 /)触发。

4.1 全局

操作 macOS Windows / Linux
新建会话 ⌘N Ctrl+N
打开命令面板(Header 搜索) ⌘K Ctrl+K
关闭设置 / 弹窗 / 命令面板 Esc Esc

4.2 会话输入框

操作 macOS Windows / Linux
发送消息 Enter
换行 ⇧⏎ Shift+Enter
入队补充(运行中) Enter
弹出命令面板 输入 / 输入 /

4.3 命令面板(输入 / 后)

操作 macOS Windows / Linux
上 / 下选择 ↑ / ↓ ↑ / ↓
执行 Enter
关闭 Esc Esc

5. 输入框 Slash 命令参考

5.1 通用命令

命令 参数 说明
/new [name] 新建会话;可附名称
/clear 清空当前会话所有消息
/copy 复制最后一条 AI 回复
/compact [keep <N>] 触发历史折叠;可保留最近 N 条原文
/memorize <text> 写入一条长期记忆
/memory 打开记忆宫殿面板
/help 列出当前可用命令

5.2 触发技能

命令 参数 说明
/skill:<name> 取决于技能 渲染该技能模板并注入下一回合
/skill:<name> <arg1> <arg2> … 位置参数 替换技能模板中的 $1 $2

5.3 行为细节

  • 命令行首必须以 / 开头,命令名忽略大小写。
  • 命令与参数之间用空格分隔;含空格的参数请用 "双引号" 包裹。
  • 命令面板(输入 / 弹出)支持 ↑ / ↓ 选择、 执行、Esc 关闭。
  • 已加载的技能会以 /skill:<name> 形式动态出现在命令面板里。

6. 随行通讯命令参考

6.1 命令清单

命令 参数 作用域 说明
/bind <6 位配对码> 单聊 / 群 绑定该 IM 对端到工作区
/ws <工作区名> 单聊 / 群 切换当前对端的工作区(持久)
/sessions 单聊 / 群 列出最近会话(含短 id)
/new [文本] 单聊 / 群 新建会话;可附首条消息
/s <短 id> 单聊 / 群 切到指定会话(≥4 字符前缀)
/approve <审批号> 单聊 / 群 允许本次
/always <审批号> 单聊 / 群 始终允许(写白名单)
/deny <审批号> 单聊 / 群 拒绝
/stop 单聊 / 群 停止当前对端的会话
/resume 单聊 / 群 恢复被 /stop 暂停的会话
/help 单聊 / 群 列出所有命令

单条临时覆盖(前缀标签)

前缀 作用
[ws:<工作区名>] 消息正文 该条消息单次切换工作区,下条恢复
[s:<短 id>] 消息正文 该条消息单次切到指定会话,下条恢复

6.2 入站路由优先级

按以下顺序匹配,前者命中即停:

  1. 明确的 /s <短id> 切换
  2. 明确的 /new 新建
  3. 当前对端绑定的最近活跃会话
  4. inline 单条覆盖标记 [ws:xxx] / [s:xxx]
  5. 配对码 / 工作区默认 fallback

6.3 出站节流

参数 默认 说明
最小批量 200 字 累积到该长度才发出
空闲触发 3 秒 无新增字符即立即发出
最大单段 3800 字 避免触达 IM 单条上限
Markdown 过滤 自动转纯文本,避免 IM 渲染错乱
Typing 指示 处理中显示「输入中」

6.4 出站工具

下列工具可被助手主动调用,把信息推到 IM。

工具 参数 用途
channels.notify workspace_id, text 广播到该工作区所有绑定
channels.reply session_id, text 回到触发该会话的原对端
channels.send_to binding_id(或 account+peer), text 精确直发到指定对端
channels.list_bindings 列出该工作区所有绑定
channels.list_sessions workspace_id 列出该工作区可投递的会话

7. 智能编程工具参考

7.1 工具一览

工具 用途 默认权限
fs.read 读文件(按行 / 按字节) 启用
fs.write 覆盖写整个文件 询问
fs.patch 基于行号 + 校验哈希做精确替换 询问
fs.list 列目录 启用
fs.glob 通配符匹配文件名 启用
fs.grep 内容正则搜索 启用
fs.exec 同步执行命令 询问
fs.exec.start 启动后台命令,返回 session_id 询问
fs.exec.tail 拉取后台命令实时输出 启用
fs.exec.kill 终止后台命令 启用
fs.exec.list 列出当前后台命令 启用
time.now 获取当前时间(带时区) 启用
git.status 仓库状态 启用
git.branch 创建 / 切换分支 询问
git.init 初始化仓库 询问
web.bing Bing 搜索(RSS 端点) 启用
web.fetch 抓取指定 URL 并清洗为可阅读文本 启用
skill.list 列出当前可用技能 启用
skill.invoke 渲染并调用某个技能 启用
TodoWrite 写入 / 更新待办列表(最多 50 条) 启用
TaskWait 阻塞等待后台任务 / 子代理(默认 5min,最长 30min;支持 all / any 启用
SuggestTask AI 主动建议一个分外任务(卡片形式挂在消息流,不打断当前正事) 启用
DismissTask AI 撤回已过时的建议任务 启用
mcp.list_servers 列出所有 MCP server 启用
mcp.describe_server 查看某 server 详情(密钥脱敏) 启用
mcp.list_tools 查看某 server 暴露的工具 启用
mcp.test_server 真握手探活(30s 预算,含 4 阶段) 启用
mcp.add_server 新增 server(写类,两步制 confirm=true 询问
mcp.remove_server 删除 server(写类,两步制) 询问
mcp.toggle_server 启停 server(写类,两步制) 询问
mcp.import_config 批量导入;支持 Claude Desktop schema(写类,两步制) 询问
mcp.export_config 导出当前配置(密钥脱敏) 启用

7.2 通用返回字段

读取 / 搜索类工具的返回都包含:

字段 类型 说明
truncated bool 是否被软上限 / 硬上限截断
next_offset int 下次按行读的起始行号
next_byte_offset int 下次按字节读的起始字节
content_hash string 整文件内容指纹(写入校验用)
line_hashes array 行级指纹(patch 校验用)

7.3 read

参数 类型 默认 说明
path string 相对工作区根;必填
mode enum lines lines / bytes
offset int 0 起始行号 / 字节偏移
limit int 软上限 4096 字节上限;硬上限 256 KiB

7.4 write

参数 类型 默认 说明
path string 必填
content string 必填
expected_hash string 上次 read 返回的 content_hash;用于并发覆写校验(CAS)

7.5 patch

参数 类型 默认 说明
path string 必填
start_line int 1-based
end_line int 1-based,含
replacement string 新内容
verify_hashes array 该行号区间的 line_hashes;不匹配则拒绝

7.6 list

参数 类型 默认 说明
path string . 相对工作区根
pattern string * shell 风格通配
include_hidden bool false 是否包含隐藏文件
sort enum name name / mtime / size
limit int 4096 字节 单次返回总长度上限

7.7 glob

参数 类型 默认 说明
pattern string 通配符表达式
path string . 相对工作区根
sort enum mtime mtime / name
自动跳过 .git/ node_modules/ dist/ 不可解除

7.8 grep

参数 类型 默认 说明
pattern string RE2 正则
path string . 相对工作区根
path_glob string **/* 文件名过滤
case enum smart sensitive / insensitive / smart
context int 0 上下文行数
include_binary bool false 默认启发式跳过二进制

7.9 fs.exec / fs.exec.start

参数 类型 默认 说明
cmd string 必填
cwd string 工作区根 相对路径
timeout_seconds int 120 超过即终止
env object 追加环境变量
stdin string 选填
output_byte_limit int 4096 / 256 KiB 软上限 / 硬上限(stdout、stderr 各自)

7.10 fs.exec.tail / fs.exec.kill / fs.exec.list

工具 参数 说明
fs.exec.tail session_id, since_offset(opt) 拉取增量输出
fs.exec.kill session_id 强制终止
fs.exec.list 当前所有后台会话列表

后台会话上限:最多 16 个并发;单会话磁盘日志 256 MiB;进程退出后日志可继续拉取,1 小时后 GC 回收。

7.11 web.bing / web.fetch

工具 参数 说明
web.bing query, top_k(默认 5) Bing RSS 搜索;返回标题 / 摘要 / URL
web.fetch url, format(md/txt/html) 抓取并清洗

8. 安全分析工具参考

8.1 适用约束

  • 全部工具仅在当前工作区下名为 samples/ 的子目录中可用。
  • 该子目录下 exec 类工具被强制禁用,且不可解除。
  • 所有工具都是只读的;不会修改样本本体。

8.1.1 样本投放入口

入口 行为
输入框左下角「+」按钮 系统多文件对话框 → 落到 <workspace>/samples/
用户取消选择 静默忽略,不报错
重名 自动附加时间戳后缀,不覆盖
无活动工作区 按钮置灰;点击提示「没有活动工作区」

后端透明支持本地与远程工作区。

8.2 工具一览(共 16 个)

工具 用途
sec.hash 多算法哈希(md5 / sha1 / sha256 / sha512 等)
sec.entropy Shannon 熵(总 + 分块)
sec.hexdump xxd 风格十六进制 + ASCII 视图
sec.strings 提取 ASCII + UTF-16LE 字符串
sec.ioc_extract 提取 IPv4 / IPv6 / URL / domain / email / BTC / hash / Win+Unix 路径
sec.pe_parse PE / PE+ 结构(节、导入、导出、入口、子系统)
sec.elf_parse ELF 结构(节、动态依赖、符号、build-id)
sec.macho_parse Mach-O 结构(含 FAT / universal)
sec.imphash Mandiant-style PE 导入哈希
sec.disasm 线性反汇编(架构自动嗅探)
sec.decompile LLM 辅助反编译为 C / Java 伪代码
sec.pcap_info pcap 元信息 + Top-N 流聚合
sec.pcap_stream_list 列出 pcap 中所有 TCP/UDP/ICMP 流并赋稳定 id
sec.pcap_stream_extract 把指定流的 L7 载荷 dump 到工作区路径
sec.pcap_extract DNS / HTTP / TLS ClientHello SNI 字段抽取
sec.yara_scan YARA 规则扫描(默认 build 为 stub)

8.3 sec.hash

参数 类型 默认 说明
path string 必填
algorithms array [md5, sha1, sha256] 可选:md5, sha1, sha256, sha384, sha512, sm3

8.4 sec.entropy

参数 类型 默认 说明
path string 必填
block_size int 4096 0 表示不分块

8.5 sec.strings

参数 类型 默认 说明
path string 必填
min_len int 6 最小长度
encodings array [ascii, utf16le]
limit int 软 4096 / 硬 256 KiB

8.6 sec.ioc_extract

参数 类型 默认 说明
path string 必填
categories array 全部 见下表

可选 categories

类别 含义
ipv4 / ipv6 IP 地址
url http(s):// 链接
domain 域名
email 邮箱
hash 类哈希字符串(按长度判定)
path_unix / path_windows 路径式字符串
bitcoin 比特币地址
cve CVE 编号

8.7 sec.pe_parse / sec.elf_parse / sec.macho_parse

参数 类型 默认 说明
path string 必填
sections bool true 节列表
imports bool true 导入表(PE)/ 动态依赖(ELF)
exports bool true 导出表
signatures bool false 签名 / 证书链

8.8 sec.disasm

参数 类型 默认 说明
path string 必填
arch enum auto auto / x86 / x86_64 / arm / arm64 / ppc64
start int / hex 文件入口 起始虚拟地址 / 偏移
length int 4096 反汇编字节长度

8.9 sec.decompile

参数 类型 默认 说明
path string 必填
target enum c c / java
function string 入口 函数名或起始地址

隐私提示:sec.decompile 会把反汇编片段送往反编译模型;只在样本可外送的前提下使用。

8.10 sec.pcap_info / sec.pcap_stream_list / sec.pcap_stream_extract / sec.pcap_extract

工具 参数 说明
sec.pcap_info path 总包数 / 起止时间 / 协议占比 / TopN 流
sec.pcap_stream_list path 列出全部 TCP/UDP/ICMP 流,按首包时间排序赋稳定 id
sec.pcap_stream_extract path, stream_id, out_path(相对工作区根,可写到 samples/ 之外) dump 该流 L7 载荷为文件
sec.pcap_extract path, protocol(dns/http/tls_sni), limit 协议感知字段抽取,返回 IOC(IP 等)

v1 仅做单包检视,不做 TCP 重组。

8.11 sec.yara_scan

参数 类型 默认 说明
path string 必填
rules string 内置规则集 规则文件相对路径或内置集合名
timeout_ms int 60_000 超时即终止

9. 外部工具服务接入参考

9.1 服务条目字段

每个外部服务条目包含:

字段 类型 说明
name string 名字(也作为工具前缀,例如 notion.*
protocol enum http / sse
endpoint string URL
credential string Bearer Token 或 API Key
enabled bool 是否启用
timeout_ms int 请求超时
retry object max=3, base=500ms, jitter=0.3

9.2 工具命名规则

来源 命名
内置工具 不加前缀(例如 read, git.status
安全分析 sec.* 前缀
外部服务 <服务 name>.* 前缀(例如 notion.search
通讯出站 channels.* 前缀
技能调用 skill.invoke

9.3 错误抽屉条目

字段 说明
时间 触发时间
工具 工具名
状态码 / 错误类 HTTP 状态 / 异常类
摘要 单行简述
详情 服务端原始返回(最多 4 KB)
重试次数 自动重试已尝试次数

10. 工具权限策略参考

10.1 三态语义

状态 图标 行为
启用 直接放行,不弹窗
询问 每次调用前弹窗审批
禁用 直接拒绝,记录到错误抽屉

10.2 多端聚合优先级

并发审批决策按下列优先级聚合(前者胜):

deny  >  defer  >  ask  >  allow

10.3 白名单匹配粒度

粒度 覆盖范围 适用场景
仅本次 单次调用 谨慎评估
同工具同参数 一组完全相同的入参 推荐默认
同工具任何参数 该工具任意调用 内部脚本
整工作区放行 该工作区所有工具 仅限隔离环境

10.4 远程审批回写

命令 等价桌面操作
/approve <审批号> 允许(仅本次)
/always <审批号> 始终允许
/deny <审批号> 拒绝
不回复 自动 30 秒后转挂起;2 小时后超时拒绝

10.4.1 无限制模式(高级)

输入区模式滑块右侧盾牌开关;按会话独立、纯内存、重启即清。开启前有 5 秒冷静期。

解除 开启后行为
工具批准 跳过批准弹窗,仍写审计
命令白名单 fs.exec 不限命令
网络过滤 web.fetch / web.bing 不过滤内网 / 环回 / 链路本地

始终保留的硬底线(不受开关影响):

硬底线 说明
samples/ 沙箱 不可解除
rm -rf 参数校验 仍校验
危险注入黑名单 fork 炸弹 / 写 /etc / curl|sh / eval
协议白名单 http(s) 放行

10.5 审计字段

每次审批结果作为独立卡片记录到会话流,字段:

字段 说明
request_id 审批号
tool 工具名
params 入参摘要
decision allow / always / deny / defer
decided_by desktop / im:<binding_id>
decided_at 时间戳
latency_ms 弹出到决策的耗时

11. 计划与待办状态参考

11.1 计划(Plan)状态机

状态 触发 下一态
起草中 助手开始写计划 草稿就绪
草稿就绪 助手发出完整计划 已接受 / 已修改 / 已拒绝
已修改 用户编辑后回交 起草中(再补完善)
已接受 用户点击「接受」 进入执行
已拒绝 用户点击「拒绝」 助手重写

11.2 待办(Todo)状态

状态 图标 说明
待办 尚未开始
进行中 助手当前正在做
完成 已完成
失败 已失败或被跳过

11.3 跨折叠保留

历史折叠发生时,下列字段始终原样保留在新摘要中:

  • 计划当前状态(起草中 / 草稿就绪 / …)
  • 计划的最新版本号与差异概要
  • 待办列表的全部条目与其状态
  • 用户已确认的关键决策("接受了 v3 计划")
  • 上下文必需事实(路径、版本号)

12. 技能(SKILL.md)格式参考

12.1 文件结构

<skill-root>/
├── SKILL.md              # 必需。前置元数据 + 模板正文
├── README.md             # 可选。给人看的说明
├── examples/             # 可选。示例输入输出
└── …                     # 可选附加资源

12.2 前置元数据字段

SKILL.md 顶部使用 --- 分隔的 YAML 前置元数据,所有可识别字段:

字段 类型 必填 说明
name string 用作 slash 名(建议小写连字符)
description string 一句话说明,列在 /help
argument-hint string <arg1> <arg2> 提示
allowed-tools array 限制本技能可用的工具白名单
denied-tools array 黑名单(与白名单二选一)
work-modes array 适用工作模式 [plan, execute, …]
model string 强制使用的模型;缺省继承当前
temperature number 强制温度;缺省继承当前
version string 语义化版本号
license string SPDX 标识
author string 作者 / 团队
tags array 用于市场过滤
signature string 国密签名块(由签名工具自动写入)

12.3 正文模板

正文为标准 Markdown,支持下列扩展:

语法 含义
$1 $2 $N 第 N 个位置参数
$ARGUMENTS 全部参数原样拼接
!`<shell>` Shell 预处理;输出替换该位置
{{include:path}} 内联另一个 Markdown 文件(相对 skill-root)

12.4 三层加载优先级

层级 路径 优先级
全局 应用数据目录的全局技能区 最低
工作区 <workspace>/.config/skills/<name>/
插件 插件包内提供

12.5 调用方式

方式 触发点 行为
用户 slash /<name> <args> 渲染后注入下一回合 system prompt
助手主动 skill.invoke 工具 渲染后作为工具响应回到对话流

13. 助手人设参考

13.1 人设字段

字段 类型 必填 说明
id string 内部 ID;系统消息携带
name string 显示名
personality string 短句个性
soul string 完整核心提示词
soul_path string 引用 Markdown 文件作为 SOUL(与 soul 二选一)
default_model string 默认模型
default_temperature number 默认温度

13.2 内置人设

ID 名称 默认模式
builtin/auto 自动 auto
builtin/plan 筹划 plan
builtin/prepare 准备 prepare
builtin/execute 执行 execute
builtin/assess 评估 assess

13.3 模式 → 助手绑定

每个工作区维护一份 5 项映射(mode → persona id):

mode_persona:
  auto:    builtin/auto
  plan:    builtin/plan
  prepare: builtin/prepare
  execute: builtin/execute
  assess:  builtin/assess

14. 模型 Provider 参考

14.1 Provider 字段

字段 类型 必填 说明
name string Provider 标识
display_name string 显示名
base_url string API 基础地址
api_key string 凭证(共享额度走系统下发,无需填写)
protocol enum openai-compat / anthropic / gemini / custom
models array 模型列表;空时启动后异步拉取
priority int 100 兜底排序
enabled bool true 是否启用

14.2 内置 Provider 占位

name 说明
AVL-Zero 共享额度入口;登录后自动下发 key
OpenAI 标准 OpenAI 协议
Anthropic Claude 系列
Aliyun 阿里云通义系列
Volcengine 火山方舟

14.3 参数命名映射

通用名 OpenAI Anthropic Aliyun
temperature temperature temperature temperature
top_p top_p top_p top_p
max_output_tokens max_tokens max_tokens max_tokens
stream stream stream stream
stop stop stop_sequences stop

15. 历史折叠(Compact)参考

15.1 触发方式

来源 时机
手动 用户 ⌘⇧K / 标签右键 / /compact
自动 助手在自身 context 接近上限时反向触发
会话切换 切到长会话时按需

15.2 折叠摘要的字段

字段 说明
compacted_from_ids 被折叠的原消息 id 列表
summary LLM 生成的摘要正文
plan 当时计划的最新状态
todos 当时待办的全部条目
decisions 用户已确认的关键决策
facts 必需事实(路径、版本号、配置项等)
excluded_from_context 被折叠的原消息是否对 LLM 隐藏

15.3 多次折叠

折叠是 append-only 的:每次折叠都新增一条节点而非替换;UI 上以"折叠摘要 →(展开)→ 原消息"层叠展示,可逐层展开到最早历史。


16. 子任务与后台执行参考

16.1 派发参数

参数 类型 默认 说明
prompt string 子任务提示词;必填
agent_id string 当前助手 指派子助手人设
model string 当前模型 子任务模型
run_in_background bool false true 走后台
timeout_ms int 600_000 前台超时;后台不适用

16.2 BackgroundRegistry

字段 默认 说明
同时在跑上限 64 超出立即拒绝并提示稍后重试
终态保留 30 分钟 超过窗口被回收
优先级 killed > done 外部 stop 与自然结束撞拍时 killed 胜

16.3 子任务工具

工具 参数 说明
Agent prompt, agent_id, run_in_background? 派发子任务
TaskOutput task_id, limit? 拉取后台任务状态 / 输出片段
TaskStop task_id 强制终止后台任务
TaskWait task_ids, mode=all|any, timeout_seconds(默认 300,最长 1800) 阻塞等待后台任务 / 子代理;超时返回「还在跑」让模型决定继续
EnterPlanMode / ExitPlanMode 进入 / 退出筹划
TodoWrite todos 写入或更新待办列表

17. 命令行入口参考

命令行版本与桌面版共享同一份会话与配置,互相之间可以接力。

17.1 主子命令

命令 用途
avl tui 在终端里启动 TUI 版本,与桌面版共享同一份会话
avl zagent-tui 直接启动批处理对话 TUI,适合脚本化驱动
avl workspace 工作区操作
avl agent 一次性 LLM 对话(JSONL 批处理)
avl skill 技能管理与签名
avl channel 随行通讯(独立运行 / dry-run / 主 App 回调)
avl mcp 外部工具服务连接调试
avl install 在当前目录安装 5 个子命令的入口符号链接

tui / zagent-tui 由主二进制内置,无需额外安装 zBoxFull 发行包。

17.2 通用参数

参数 含义
`--workspace <id path>`
--config <path> 显式指定配置目录
--log-level <level> error / warn / info / debug
--no-color 关闭彩色输出
-h / --help 帮助
-V / --version 版本号

17.3 退出码

含义
0 成功
1 通用错误
2 参数错误
64 配置错误
65 数据错误
69 服务不可用
70 软件错误(应反馈)

18. 主题与外观参考

18.1 主题三档

模式 触发 表现
system 跟随系统 自动切换
light 浅色 纯灰阶 + 暖白底
dark 深色 OKLCH 蓝调 + 高对比度

18.2 关键色(用户可感知)

角色 浅色 深色
主品牌 深蓝 浅蓝
强调 / 链接 浅蓝
状态 · 成功 绿 绿
状态 · 警告 琥珀 琥珀
状态 · 错误

18.3 字体

角色 默认
界面 系统 UI 字体
等宽 系统等宽(SF Mono / Consolas / JetBrains Mono …)
字号档位 小 / 中 / 大(默认中)

19. 系统集成参考

19.1 系统托盘

说明
启用条件 设置 → 通用 → 最小化到系统托盘 开启
托盘图标 平台原生图标,跟随主题切换
关窗行为 隐藏到托盘并保留后台进程
菜单项 显示窗口 / 设置 / 检查更新 / 退出
macOS 限制 启停需重启应用生效

19.2 开机自启

平台 实现位置
macOS ~/Library/LaunchAgents/<AppID>.plist
Windows HKCU\Software\Microsoft\Windows\CurrentVersion\Run
Linux ~/.config/autostart/<AppID>.desktop

启动参数:--from-autostart,配合"最小化到托盘"走静默启动。

19.3 通知

事件 默认通知
后台任务完成 系统通知中心
待审批 系统通知中心(如桌面在前台则只弹 modal)
点数到期 状态点 + 一次性 toast
升级可用 一次性 toast;可推迟

19.4 在线文档入口

入口 行为
侧边栏「帮助」按钮 系统默认浏览器打开 https://avlcode.cn/docs
macOS 帮助菜单 → 在线文档 同上(紧跟在「命令列表」后)

20. 状态指示与提示参考

20.1 左侧栏状态点

颜色 含义
绿 一切正常
琥珀 凭证 1 小时内到期 / 限流警告 / 通道重连中
离线 / 凭证已过期 / 严重错误
未登录

20.2 会话标签徽章

徽章 含义
数字 该会话有 N 条新消息(仅当切换走时累计)
该会话当前有助手在运行
🌙 该会话当前有后台子任务
红点 该会话有未处理的审批请求

20.3 输入框右侧按钮

形态 含义
发送(默认) 助手空闲;点击发送当前输入
停止 助手运行中;点击同步终止主助手 + 所有子任务
置灰 输入框为空

21. 错误信息参考

下表收录用户最常见的提示文案及其含义与处置建议。

提示文案 含义 处置
服务未就绪 后台子进程仍在初始化 等待 30 秒;超时则查看错误抽屉
工具调用被拒绝 工具被设为禁用 / 被审批拒绝 / 路径越权 检查工具权限策略与路径范围
模型超时 LLM 长时间无响应 重发;或切到备用 Provider
模型返回为空 LLM 输出长度为 0 多见于触发拦截;尝试改写 prompt
上下文超长 接近模型 context 上限 触发折叠或开新会话
工作区已锁定 该工作区已有进程持有 等待或重启应用
凭证已过期 登录 token 失效 重新登录
点数余额不足(HTTP 402) 账号点数耗尽 「前往服务页面充值」(不再当成可重试错误反复重试)
套餐额度已用尽(HTTP 429) 套餐配额耗尽 「等配额刷新或升级套餐」(不再误判成限流)
鉴权失败(HTTP 401 / 403) 需要登录 / Key 失效 「重新登录或重发 key」(不再让你去查配置)
当前模型暂无可用通道(HTTP 503) 通道全部不可用 稍后重试或切换模型
上游服务异常(HTTP 502 / 529 / overloaded) 上游问题 如实说明是上游;上游鉴权失败时不再误导你去查自己的 key
Provider 端点不存在(HTTP 404,endpoint_not_found_error URL 路径写错 检查 Provider Base URL;与"API JSON 返回的 404 模型不存在"分流
macOS App Translocation 应用在只读临时镜像运行(未拖进"应用程序") 「退出应用 → 拖进『应用程序』→ 重新打开 → 再检查更新」
通道断开 IM 通道掉线 自动重试;30 秒后仍失败请重新扫码
配对码无效 6 位码错误或过期(10 分钟) 重新生成
升级签名无效 升级包签名校验失败 自动回滚;手动通过应用内升级再试
技能签名无效 技能包签名校验失败 拒绝执行;联系发布方
后台任务上限 在跑后台任务达到 64 等待回收或主动终止

22. 数据与备份参考

22.1 备份内容

说明
工作区列表 名称、路径、归档状态
会话历史 全量消息流,含工具调用、计划、待办、审批
助手人设 内置 + 自定义
技能 全局 + 工作区 + 插件提供
工具策略 三态权限 + 白名单
外部服务 凭证以加密形式存储
通道绑定 IM 对端 ↔ 工作区
设置项 通用 + 工作区

22.2 备份与恢复

操作 步骤
备份 关闭应用 → 设置 → 数据 → 数据目录 → 整目录打包
恢复 关闭应用 → 替换原数据目录 → 启动应用
跨设备迁移 备份后还原到新设备同名目录
同步(实验性) 设置 → 数据 → 同步 开启后多设备共享

22.3 完整清理

关闭应用 → 删除应用本体 → 删除数据目录

数据目录包含登录凭证、会话历史、外部服务凭证;删除后不可恢复


22.6.1 SSH 远程工作区协议

字段 类型 默认 说明
协议 enum zworkspace zworkspace / ssh
主机 string user@host[:port]
认证 enum password password / private_key / private_key_with_passphrase
私钥路径 string 文件选择器挑选;本机解析
远程根目录 string ~ 支持 ~ 自动展开为远端家目录;防 .. 逃逸
凭据加密 SM4-GCM 国密落盘 + 本机绑定
主机指纹 accept-new 首次连接「记住首次指纹」

SSH 工作区与本地工作区的差异:

能力 本地 SSH
fs.* 文件操作 本地 走 SFTP / 远端 shell
fs.grep Go RE2 远端系统 grep(提速)
fs.exec 同步 本地 远端 shell
fs.exec.start 后台长驻 启用 拒绝(工具面隐藏)
文件变更面板 git 本地 git 远端 git(无 git 时隐藏面板)
Skills / Plugins / Hooks 本地 .zcode/ 远端 .zcode/
文件威胁扫描 本地字节 SFTP 取字节后扫描
sys.info 报告身份 本地 远端真实身份
「关闭并清除数据」菜单项 显示 不显示 + 后端拒绝(避免误删远端文件)
「移除工作区」 删本地记录与凭据 删本地记录与凭据(不碰远端文件)

22.6.2 会话附加目录

字段 类型 默认 说明
入口 输入框「+」菜单:附加目录(只读) / 附加目录(读写)
权限 enum ro(读 / 列举 / 搜索) / rw(额外允许写 / 删 / 创建)
作用域 会话 仅当前会话;其它会话不受影响
持久化 会话内 随会话保存;重启后台自动重新生效
显示 输入框上方「附加路径」条 可随时移除
路径标注 绝对路径 搜索 / 列举结果标绝对路径,来源一目了然
会话身份注入 系统在调用链注入 _session_id AI 不可伪造身份冒用别会话的附加权限

22.7 项目指令(AGENTS.md)

工作区根目录放 AGENT.md / AGENTS.md / CLAUDE.md(按优先级取一份),自动作为系统提示里的「# 项目指令」块。

字段 行为
文件名优先级 AGENT.md > AGENTS.md > CLAUDE.md(取第一个存在的)
注入位置 系统提示词独立「# 项目指令」块
重新读取 每轮重新读,改了立即生效
子目录注入 AI 读写某子目录下文件时,自动把路径上各级 AGENT.md 一并注入(每会话每子目录一次,去重不刷屏)
截断策略 UTF-8 字符边界安全截断 + 截断标记
软链护栏 EvalSymlinks 真实路径校验,不在工作区内则拒绝
内置编辑器 会话菜单 / 工作区菜单「编辑 AGENTS.md」;Cmd/Ctrl+S 保存、Tab / Shift+Tab 缩进、未保存保护、空状态模板

22.8 消息内链接与文件路径点击行为

类别 识别 点击行为
工作区内文件路径 带常见扩展名(如 src/main.go / README.md 系统文件管理器定位并选中
外部链接 http(s) URL 默认浏览器打开
反引号内联代码里的路径 带扩展名 与普通链接同等识别
普通内联代码 不识别为链接
危险协议 http(s) 拦截
纯目录 / 无扩展名片段 a/b/etc/hosts 不可点

点击后弹出非模态浮动工具条(主动作「查看 / 打开」+「复制」),用 Popover API 渲染在顶层,弹窗内点击同样不被遮挡。

23. 文件命名约定

下表为用户可见的文件命名规则,方便手工脚本化处理(不要修改这些文件,除非显式说明可以)。

类别 命名格式 说明
会话文件 <sid>.jsonl sid 为 8 字符随机;前 4 位为短 id
计划快照 <sid>.plan.json 与 jsonl 同名
待办快照 <sid>.todos.json
工作区配置 agents.yaml tools.yaml channels.yaml 各功能独立文件
技能 <skill-name>/SKILL.md 技能根目录名建议小写连字符
助手人设 <persona-id>.yaml 路径斜杠以 __ 编码
日志 zcode-YYYYMMDD.log 按日轮转

24. 网络访问清单

下表收录应用可能发起的网络请求,便于在受限网络环境中加白。

用途 协议 说明
登录 / 共享额度 / 用量 HTTPS 账号管理后台
模型调用(共享) HTTPS 共享额度走的模型供应商
模型调用(自有 Key) HTTPS 你配置的模型供应商
升级检查 HTTPS 内部升级源
网页检索(可选) HTTPS 仅启用 web.search 时
通道(微信 iLink) HTTPS / WebSocket 仅启用随行通讯时
外部工具服务 HTTPS / SSE 仅启用 MCP 服务时

应用不会

  • 主动联网做行为埋点。
  • 把样本本体上传到任何第三方(仅反编译会按需发反汇编片段)。
  • 自动同步本地会话到云(除非显式启用同步开关)。

25. 隐私与遥测参考

25.1 默认行为

默认 说明
行为埋点 不主动上报
崩溃栈 询问 崩溃时弹窗询问是否上报
模型对话 走你选择的 Provider 相应隐私协议适用
反编译片段 调用时即送 由你显式触发
样本本体 永不上传 仅本地分析

25.2 加密存储项

下列条目以受保护方式存储在本机:

  • 登录凭证
  • 模型 Provider API Key
  • 外部工具服务 Bearer Token / 凭证
  • 通道(微信 iLink)会话状态

25.3 会话内容

会话内容仅在本机持久化;只有你主动调用模型时才把对应消息按 Provider 协议发出。


26. 升级与版本号参考

26.1 版本号格式

MAJOR.MINOR.PATCH[-PRERELEASE][+BUILD]
含义
MAJOR 不兼容更改(数据迁移 / 配置不兼容)
MINOR 新功能(向后兼容)
PATCH 修复 / 优化(向后兼容)
PRERELEASE alpha.<n> / beta.<n> / rc.<n>
BUILD 构建元数据,不参与版本比较

26.2 升级路径

路径 频率 说明
应用内升级 默认每天检查 推荐
手动安装包 按需 配置目录不动
内部市场 视团队配置 组织管理员控制版本

26.3 升级签名

步骤 说明
下载 从内部升级源拉到本地缓存
验签 国密签名 + 嵌入公钥校验
替换 验签通过后原子替换主二进制
回滚 验签失败 / 启动失败时自动回滚到上一版本

27. 附录 A:术语表

术语 定义
工作区(Workspace) 绑定一个本地目录与一组配置的执行单位
会话(Session) 一次连贯的对话上下文,本地持久化
工作模式 五种之一(auto / plan / prepare / execute / assess)
助手 / 人设(Persona) 决定 AI 风格与边界的提示词集合
工具(Tool) AI 可调用的能力
技能(Skill) 提示词模板包
子任务(Subtask) 助手派发给独立子助手执行的子工作
计划(Plan) 结构化任务规划
待办(Todo) 结构化任务清单
历史折叠(Compact) 把早期消息压缩为摘要,原消息仍保留
审批(Approval) 工具调用前的允许 / 拒绝 / 挂起决策
随行通讯(Messaging) 把 AI 助手接入 IM 通道
共享额度 由组织统一管理 / 计费的模型调用额度
错误抽屉 把最近的工具与服务错误集中展示的面板
配对码 6 位数字、10 分钟有效,用于 IM 绑定

28. 附录 B:参数取值速查

28.1 默认上限

默认 上限
单次工具返回 4096 字节 256 KiB
单次出站消息 3800 字 取决于 IM
终端命令超时 60_000 ms 可调
后台任务并发 64 不可调
后台任务终态保留 30 分钟 不可调
配对码 TTL 10 分钟 不可调
登录凭证 TTL 23h45m 不可调

28.2 文件大小硬上限(工具读取)

工具 上限
read (lines) 256 KiB
read (bytes) 256 KiB
list 4 KiB
glob 256 KiB
grep 256 KiB
exec 256 KiB

28.3 退出码语义

含义 来源
0 成功 CLI / 工具
1 通用错误 CLI / 工具
2 参数错误 CLI
64–78 sysexits 系列 CLI
124 超时 exec
137 被 kill exec

29. 附录 C:常见正则与通配符语法

29.1 文件名通配(glob)

字面 含义
* 匹配任意字符(不跨 /
** 匹配任意目录层级
? 匹配单字符
[abc] 字符集
[!abc] 否定字符集
{a,b,c} 集合分支

示例:

表达式 意图
**/*.go 所有 Go 文件
src/**/*test*.{ts,tsx} src 下含 test 的 TS/TSX
[Mm]akefile Makefile / makefile

29.2 内容搜索(RE2)

元字符 含义
. 单字符(不含换行)
\d \w \s 数字 / 词字符 / 空白
^ $ 行首 / 行尾
\b 词边界
(?i) 行内忽略大小写
(...) 捕获组
(?:...) 非捕获组
+ * ? 量词
{n,m} 重复 n–m 次

不支持反向引用 \1、回溯前瞻 (?<=…) 等 PCRE 扩展。


30. 附录 D:键值清单导出格式

设置面板支持把当前所有设置导出为单一 YAML 文件,便于版本管理与团队同步。

30.1 顶层结构

version: 1
exported_at: 2026-06-13T08:00:00Z
exported_by: AVL Code v0.6.13-alpha
sections:
  account:        { … }
  models:         { … }
  personas:       { … }
  tools:          { … }
  skills:         { … }
  messaging:      { … }
  plugins:        { … }
  general:        { … }
  workspaces:     [ … ]

30.2 节字段速查

主要字段
account provider_priority
models providers[](不含明文 key)
personas [].id name personality soul_path
tools defaults policies[].mode policies[].overrides
skills signature_required extra_search_paths[]
messaging channel route_strategy throttle
plugins installed[].id installed[].version installed[].enabled
general theme language tray_enabled autostart_enabled font_size
workspaces [].id path name archived default_mode mode_persona{}

30.3 注意

  • 凭证类字段在导出时不会写入;目标设备需重新登录或填写。
  • 同步开关单独维护,不在导出范围内。

License:AVL Code Proprietary Software License — Copyright © 2024–2026 Antiy. All Rights Reserved. 文档版本:2026-06-13,对应应用版本 v0.6.13-alpha。