BANZ文档

11.1 命令行速查

本页内容

日常用工作台就够了。这一页给写脚本、在没有显示器的电脑上用 banz,或想在终端里操作的人查。

命令的格式是 banz 名词 动词 [参数] [选项]。不知道有哪些命令时:

banz --help                # 所有名词和动词
banz session --help        # 一个名词下的动词
banz session send --help   # 一个命令的参数、选项和风险级别

全部名词

名词 管什么 动词
agent agent activity、create、delete、edit、hosted、list、pause、resume、view
auth 账号、登录、第二因素、外部账号 connect、disconnect、email-code、factor-add、factor-confirm、factor-remove、factors、forget、login、login-list、logins、logout、password、profile、recovery-codes、reset-code、signin-code、signin-factor、status
automation 自动化 archive、create、edit、list、pause、runs、view
chat 聊天、群聊和话题 add、group、leave、list、mark、read、remove、retitle、retract、send、start、topic、topic-join、topic-leave、topic-retitle、topics、view
config 设置 get、list、reset、set
copy 别人的会话和你其他设备上的会话 commands、list、messages、requests、turns、view
device 设备 disconnect、list、messages、reconnect、remove、revoke、sessions、tree
flow 工作流 archive、cancel、check、create、decide、edit、export、list、output、pause、publish、retry、run、run-step、run-view、runs、schedule、session-run、step、subject-runs、version、versions、view
harness agent 程序 connect、disconnect、list、skills
host 本机的 banz backup、doctor、events、logs、restart、status、stop
inbox 收件箱 list、mark、summary
invitation 你收到的组织邀请 accept、decline、list
memory 记忆和设备记忆 add、cancel、correct、decide、device-forget、device-note、device-recall、export、forget、history、import、index、injections、learn、list、promote、propose、recall、reindex、restore、resume、reviews、run、runs、search、status、view
op 你发给其他设备上会话的消息和操作,以及它们的进度 attach、cancel、chat-send、list、message、send、view
org 组织 bot、clear-logins、create、dissolve、edit、find、invitations、invite、leave、list、members、presence、revoke、role、set、settings、transfer、unset、view
project 项目,也可以简写成 pj bind、create、delete、edit、labels、list、unbind、view
search 搜索聊天 find
secretary 秘书和移交方案 dispatch、follow、hand、inbox-host、open、profile-delete、profile-draft、profile-save、profile-use、profiles、reply、rotate、status、take、wait
session 本机的会话 archive、attach-file、attachment、board、browse、changes、clear、commands、compact、create、delete、diagnostics、edit、file、fork、goal、held、import、interrupt、label、list、messages、meta、mode、open-file、pin、pins、place、queue、remove-worktree、requests、respond、restore-worktree、seen、send、shutdown、start、stat-files、turns、unarchive、unhold、unpin、usage、view、wait、waiting、yours
skill 技能 create、delete、edit、list、view
speech 语音转文字 status、transcribe
subject 主题 add、answer、create、edit、leave、link、list、remove、request、requests、sessions、transfer、unlink、view、withdraw
sync 同步 now、status、wait
terminal 终端 attach、close、input、list、open、output、resize
update 更新 apply、check、restart
webhook 项目的 Webhook 和 GitHub 连接 cancel、connect、connections、convert、coverage、create、decide、deliveries、disconnect、list、replay、request、requests、rotate、rules、state、subscriptions、view

hook 是 webhook 的旧名,banz hook … 仍然可以用。

单独的命令

命令 作用
banz web 在浏览器里打开工作台,没有运行的 banz 时会自动启动
banz desktop 打开桌面应用
banz serve 在前台运行 banz,直到你停止它;平时工作台会自己启动它
banz version 查看版本
banz completion 打印 shell 自动补全脚本
banz schema 名词.动词 打印一个命令的请求、结果和选项(见 11.2 在脚本和 agent 里用 banz)

开始和更新

banz web                     # 打开工作台
banz version                 # 查看版本
banz update check            # 检查更新
banz update apply            # 安装更新;
                            # 没有会话在忙时 banz 会自己重启到新版本,否则下次启动时生效
banz update restart --version 版本号
                            # 立即重启到已安装的新版本,
                            # 会停止所有运行中的会话(会先要你确认)

账号

banz auth login --server https://service.emphar.com --email lin@example.com
                            # 登录;密码和验证码在终端里提示输入
banz auth login --create --email lin@example.com --display-name 林晓 --signup-code 注册码
                            # 注册新账号,--display-name 是名字;
                            # 邮箱验证码会在终端里提示输入
banz auth profile --username linxiao
                            # 改 @用户名(注册时按名字自动生成,见 1.2 注册与登录)
banz auth status             # 是否已登录、登录的是谁
banz auth logout             # 退出登录
banz auth password           # 修改密码(会提示输入当前密码和新密码)
banz auth factors            # 查看第二因素和剩余的恢复码
banz auth reset-code --email lin@example.com
banz auth login --email lin@example.com --reset-code 重设码
                            # 忘记密码:先发重设码,再用它设新密码

agent 和会话

banz agent list                                            # 你能用的 agent
banz agent create 前端助手 --workdir ~/projects/website --harness claude --mode ask
                                                          # 新建 agent
banz session create 前端助手 --title 首页首屏与导航改版    # 新建会话
banz session list                                          # 本机的会话
banz session send 会话ID --text "先跑一遍移动端测试"       # 发消息,
                                                          # 也可以发 /compact 等斜杠指令
banz session messages 会话ID                               # 看会话的消息
banz session waiting                                       # 所有等你处理的会话,
                                                          # 以及回答它们的命令
banz session requests 会话ID                               # 会话在等你回答的请求
banz session respond 会话ID 请求ID --choice allow          # 回答请求
banz session interrupt 会话ID                              # 打断正在进行的一轮
banz session archive 会话ID                                # 归档
banz session usage                                         # 你付费的轮次和用量

--mode 可选 plan、ask、edits、auto、dont_ask、bypass,对应界面上的“只做计划”“先问再做”“自行编辑文件”“由智能体程序自行判断”“不询问直接拒绝”“不询问直接操作(bypass)”。

banz session respond 的回答方式:

  • 权限请求或计划:--choice allow、deny 或 deny_stop(拒绝并停止这一轮)
  • 没有选项的请求:--text "回答"
  • 一组提问:每个问题一个 --answers '{"question_id":"q1","selections":["方案 A"]}';都不想答,用 --clarify 让 agent 说明要澄清什么

其他设备上的会话

banz device tree                           # 每台设备和它的会话
banz copy list 会话ID                      # 标题、状态、在做什么
banz copy messages 会话ID --latest         # 别人的会话或其他设备上的会话的最新消息
banz op send --kind input --session-id 会话ID --text "继续"
                                          # 给另一台设备上你的会话发消息

项目、主题、看板

banz project list                                      # 你能看到的项目
banz project create 官网改版 --org qinghe              # 新建组织项目
banz project bind 官网改版 https://github.com/qinghe/website
                                                      # 绑定 GitHub 仓库
banz subject list 官网改版                             # 项目里的主题
banz subject create 官网改版 价格页上线                # 新建主题
banz subject sessions 主题ID                           # 主题里的会话
banz session board --subject 主题ID                    # 主题的看板
banz session label 会话ID --work-status done --labels 上线
                                                      # 改工作状态、加标签

project 和 subject 命令可以直接写项目名;其他命令(比如 flow、session board --project)要写项目 ID(pr_ 开头)。主题要写它的 ID(sj_ 开头),因为主题标题可能重复。

技能、工作流、自动化

banz skill list                                       # 你的技能
banz flow list 项目ID                                 # 项目的工作流
banz flow run 工作流ID --subject 主题ID               # 在主题里运行工作流
banz flow run-view 运行ID                             # 看一次运行的每个步骤
banz automation list                                  # 你的自动化
banz automation pause 自动化ID                        # 暂停自动化

沟通

banz chat list                                 # 聊天列表
banz chat start zhouming                       # 开始私聊(写对方的用户名)
banz chat send 聊天ID --body "首屏方案更新了"  # 发消息
banz chat send 聊天ID --topic 3 --body "好的"  # 在群聊里回复话题 3
banz search find 首屏                          # 搜索聊天
banz inbox list                                # 收件箱
banz inbox summary                             # 未读条目数
banz secretary status                          # 秘书的状态
banz secretary hand 条目ID                     # 交给秘书

组织和设备

banz org list                                 # 你所在的组织
banz org create --slug qinghe --display-name 青禾科技
banz org find qinghe chen                     # 查找要邀请的人(至少 2 个字符)
banz org invite qinghe chensiyuan             # 邀请(写用户名,可先用 org find 查)
banz invitation list                          # 你收到的邀请
banz invitation accept qinghe-design          # 接受邀请
banz device list                              # 这个账号的设备

记忆

banz memory list                                      # 列出记忆
banz memory search --query 首屏                       # 在本机搜索记忆,离线也能用
banz memory recall --query "首屏加载怎么优化"         # 看一个问题会召回哪些记忆
banz memory add --title 首屏指标 --text "LCP 不超过 2.5 秒" --tags 性能
banz memory reviews                                   # 等你审核的记忆
banz memory export memories.json                      # 导出到一个文件
banz memory import memories.json --preview            # 导入第一步:预览,得到指纹
banz memory import memories.json --fingerprint 指纹   # 导入第二步:确认导入

本机

banz host doctor                    # 体检:检查 banz 依赖的东西,
                                   # 并说明怎么修(见 12.1 体检与日志)
banz host status                    # banz 的运行状态
banz host logs --level warn         # 只看警告和错误
banz host backup ~/banz-backup.db    # 备份本设备(文件名不能和已有文件重复)
banz host restart                   # 重启本机的 banz
banz sync now                       # 立即同步
banz config list                    # 所有设置和当前值
banz terminal open                  # 打开一个终端
Esc

↑↓选择↵打开Esc关闭