命令与配置参考
本页是当前 Beta 的产品级索引,不替代随二进制发布的精确帮助。先运行 anytty COMMAND --help 查看当前版本的参数、默认值和示例;脚本集成优先使用命令提供的 --json 或 NDJSON 输出。
顶层命令
| 命令 | 用途 |
|---|---|
anytty |
打开 TUI |
access |
查看 daemon identity、列出和撤销客户端 grant |
attach / new / ls / kill / rm |
常用 terminal 快捷命令 |
cloud |
管理 daemon 的 Cloud enrollment 与 Edge |
completion |
生成 shell 补全脚本 |
config |
查看、修改和验证客户端配置 |
daemon |
管理当前用户 daemon |
endpoint |
管理 endpoint、route 与选择策略 |
file |
操作 endpoint daemon 文件系统 |
history |
搜索、裁剪和删除本地 terminal history |
licenses |
输出当前构建携带的第三方许可 |
pair |
创建、检查或兑换一次性 pairing claim |
terminal |
完整 terminal 生命周期与数据操作 |
全局常用 flags 包括 --config、--log-file、--socket 和 --timeout。
daemon 与 terminal
daemon 子命令:doctor、logs、restart、run、start、status、stop。
terminal 子命令 |
行为 |
|---|---|
create |
在 owning endpoint 创建进程;支持名称、工作目录、环境、尺寸、tags 和立即 attach |
attach |
用 TUI 附加到已有 terminal |
list / show |
列出或读取 terminal metadata |
rename / tag |
修改便于管理的标签,不改变稳定 ID |
resize |
请求 owner-authorized 尺寸调整 |
send |
发送文本、named keys、hex bytes 或 stdin |
capture |
获取权威 history 或最新 native screen |
stream |
流式读取精确 Live PTY bytes |
events / wait |
观察事件或等待 daemon-owned 生命周期状态 |
kill |
停止进程,保留 terminal record 与 history |
restart |
按 daemon 保存的 process specification 重新启动 |
remove |
删除已经 exited 的 terminal record |
endpoint、pair 与 access
endpoint 提供:add、disable、enable、list、policy、remove、route、set-default、share、show、test、update。route 支持在一个 endpoint 内管理 Local、SSH、Direct 或 Cloud 路径;policy 控制下一次 session 的选路方式。
endpoint share 使用一次性 TLS session 携带可移植 route 与 policy,默认 listener 为 0.0.0.0:41130、会话有效期 10 分钟。它分享连接描述,不会把 daemon grant 变成另一个客户端的权限。
pair 提供 create、import、inspect。access 提供 identity、list、revoke。pairing claim 默认 10 分钟,grant 默认 2160 小时(90 天);以当前 pair create --help 为准。
file 与 history
file 子命令:cat、copy、download、list、mkdir、move、remove、rename、stat、upload。file operation timeout 默认 2 分钟;list 默认每页 200 项。上传等待 daemon checksum 确认,下载完成后验证 checksum。
history 提供 search、prune、delete。搜索支持 literal text、glob 与 RE2 regex,并可返回上下文;delete 是不可恢复操作。
Cloud
cloud enroll 注册当前 daemon identity;status 查看运行状态;disable 暂停 Cloud 而不删除 enrollment;enable 恢复;edge 查看或重新选择 Edge。Cloud enrollment 不等于客户端配对。
配置
anytty config paths
anytty config show
anytty config show --effective
anytty config get KEY
anytty config set KEY VALUE
anytty config unset KEY
anytty config validate
配置 schema 当前为 version: 1。完整字段模板提供中文注释版 tui-v3.example.yaml和英文注释版 tui-v3.example.en.yaml。关键默认值:
| 字段 | 默认值 |
|---|---|
daemon.output_buffer.capacity_bytes |
33554432(32 MiB) |
daemon.output_buffer.resident_budget_bytes |
536870912(512 MiB) |
daemon.output_buffer.overflow |
block |
daemon.history.max_size_mb |
512(每 terminal) |
daemon.history.max_age_days |
0(不按时间删除) |
daemon.history.compression |
zstd |
daemon.history.compression_level |
fast |
tui.theme.mode |
dark |
tui.theme.palette |
host |
tui.interaction.confirm_destructive |
true |
tui.interaction.mouse |
true |
tui.terminal.auto_take_owner |
true |
常用环境变量
环境变量适合临时覆盖,长期配置优先写入 YAML。稳定用户入口包括:
| 变量 | 用途 |
|---|---|
ANYTTY_LOG_FILE / ANYTTY_LOG_LEVEL / ANYTTY_LOG_MAX_BYTES |
日志路径、级别和大小 |
ANYTTY_OUTPUT_BUFFER_CAPACITY_BYTES |
单 terminal 输出缓冲上限 |
ANYTTY_OUTPUT_RESIDENT_BUDGET_BYTES |
daemon 共享输出缓冲预算 |
ANYTTY_OUTPUT_BUFFER_OVERFLOW |
block 或 drop |
ANYTTY_HISTORY_MAX_SIZE_MB / ANYTTY_HISTORY_MAX_AGE_DAYS |
history 保留上限 |
ANYTTY_HISTORY_COMPRESSION / ANYTTY_HISTORY_COMPRESSION_LEVEL |
history 编码与档位 |
ANYTTY_TUI_THEME_MODE / ANYTTY_TUI_THEME_PALETTE |
TUI 主题基线 |
ANYTTY_TUI_CONFIRM_DESTRUCTIVE |
破坏性操作确认 |
ANYTTY_TUI_INTERACTION_MOUSE |
鼠标交互 |
ANYTTY_ALLOW_NESTED |
显式允许 nested TUI |
诊断、测试和 Cloud 内部变量不是稳定用户接口,不应写入部署脚本。
默认快捷键
| 快捷键 | 全局入口 |
|---|---|
Ctrl-P |
panels |
Ctrl-R |
resize |
Ctrl-G |
system |
Ctrl-O |
floating panel |
Ctrl-T |
tabs |
Ctrl-W |
workspaces |
Ctrl-F |
terminal picker |
Ctrl-V |
copy/history |
自定义 scene 后应以 TUI 帮助和当前配置为准。
网络端口
| 默认端口 | 场景 |
|---|---|
41120 |
Direct signaling;SSH route 默认远端 loopback signaling |
41121 |
SSH route 默认远端 loopback ICE-TCP |
41130 |
endpoint share 一次性 TLS listener |
这些都是可配置默认值。监听地址决定暴露范围,防火墙规则应只开放实际使用的路径。
数据目录
不同平台和环境可能使用不同的配置、state 与 runtime 目录。不要硬编码 ~/.config;运行 anytty config paths 获取当前配置、socket、log、history 和 clipboard history 的解析路径。endpoint 命令会单独解析 registry,并提供 --registry 覆盖。credential 私钥位于平台保护存储,不应当作普通配置文件搬运。
平台支持
| 平台 | 当前状态 |
|---|---|
| macOS x64 / arm64 | Beta 桌面构建 |
| Linux x64 / arm64 | Beta 桌面构建 |
| Windows x64 / arm64 | Beta 桌面构建 |
| Android | Beta APK;当前 release APK 未签名 |
| iOS / iPadOS | 源码可构建,公开安装包仍在准备中;最低 iOS 15 |
状态、退出码与日志字段
用于自动化时优先读取 --json、NDJSON 和 terminal lifecycle 字段。当前 CLI 退出码分类为:
| 退出码 | 含义 |
|---|---|
0 |
成功 |
1 |
未进一步分类的失败 |
2 |
参数、用法或配置输入错误 |
3 |
endpoint、terminal、route 或配置项不存在 |
4 |
当前状态冲突或请求无效,例如 endpoint 已禁用、目标已存在 |
5 |
认证或授权被拒绝 |
6 |
daemon、route、网络或服务不可用 |
7 |
操作超时或取消 |
daemon 的 typed protocol code 会映射到这些 shell 退出码。脚本不要通过匹配可变的英文错误句子判断逻辑。
daemon 日志使用文本结构化记录,基础字段包括 time、level、msg 和 pid,具体操作可附带额外上下文字段。字段集合仍可能在 Beta 期间扩展;按字段名读取时允许未知字段。用 ANYTTY_LOG_LEVEL 控制级别、ANYTTY_LOG_MAX_BYTES 控制轮转大小,并用 config paths 定位实际文件。分享前仍需人工脱敏。
术语
- daemon: 持有进程、history、file、identity 与 grant 的当前用户服务。
- client: TUI、CLI 或移动 App;只拥有自己被授予的能力。
- terminal: daemon 持有的进程会话与稳定记录。
- endpoint: 一个 daemon identity 的本地连接记录。
- route: 到达 endpoint 的 Local、SSH、Direct 或 Cloud 路径。
- claim: 短期、一次性配对材料。
- grant: daemon 给具体 client identity 的授权。
- Live: 当前 native screen/PTY 数据;与冻结 history 视图独立。
- history: daemon 上的权威终端历史,不是业务备份。