跳到正文

AnyTTY 产品文档总览

这里是 AnyTTY 产品文档的完整入口。正文围绕安装、连接、终端、文件和多端使用展开；协议实现与内部服务架构不属于这套产品文档。所有命令、默认值、平台状态和安全边界均以公开源码与当前 CLI 为依据。

建议阅读路径

  • 第一次使用： 产品介绍 -> 安装与升级 -> 快速开始 -> 终端与 TUI
  • 运行 AI 编程任务： AI Agent 工作流 -> 观察与接管 -> 历史回溯
  • 需要手机接管终端： 移动端 -> 配对与权限 -> 连接方式
  • 需要访问远程机器： Endpoint 与连接 -> Direct / SSH / Cloud -> 连接排障
  • 准备长期运行： 配置与运维 -> 安全与隐私 -> 故障排查

1. 认识 AnyTTY

  • 产品定位、适用场景与不适用场景
  • 支持的平台、客户端与当前 Beta 边界
  • daemon、client、terminal、workspace、panel 的关系
  • endpoint、route、pairing claim、grant 的基本概念
  • 实时画面、历史记录与重新接管的工作方式

2. 安装、升级与卸载

  • macOS、Linux 和 Windows 安装
  • Android 与 iOS 客户端获取方式
  • 首次启动 daemon 与环境检查
  • 升级、降级、迁移和兼容性说明
  • 卸载程序与保留或清理本地数据

先阅读快速开始。

3. 终端与桌面工作流

  • 创建、命名、附加、分离、停止和删除终端
  • TUI 导航、终端选择器和常用操作
  • workspace、分屏、panel 与浮动窗口
  • 终端状态、近期活动与后台任务
  • 实时输出、历史浏览、搜索与恢复现场
  • CLI 与 TUI 的协作方式

先阅读终端管理。

4. AI Agent 工作流

  • 用 AnyTTY skill 约定 AI 怎样创建和管理 task terminal
  • 把耗时、并行和可接管的 task 放进 terminal 池
  • 用名称及 kind、agent、project、run、task 标签组织任务
  • 查看启动命令、状态、输出、事件和退出结果
  • 从 TUI、CLI 或移动端观察并接管同一个 task
  • 搜索历史并保留可回溯的任务现场

5. 移动端与平板端

  • 添加设备与首次连接
  • 终端列表、状态和近期活动
  • 触控操作、扩展键盘与输入法
  • 前后台切换、断线重连与多设备接管
  • 平板分屏和多任务工作流
  • 移动端本地存储、权限和安全设置

6. Endpoint 与连接方式

  • Endpoint、route 与本地选择策略
  • Local、SSH、Direct 和 Cloud 的区别
  • 新增、检查、编辑和删除 endpoint
  • 路由优先级、连接回退与失败原则
  • NAT、防火墙、代理和企业网络要求
  • 延迟、连接质量与路径诊断

先阅读连接方式。

7. 配对、授权与设备管理

  • 生成二维码或文本 pairing claim
  • 扫码、粘贴和一次性兑换流程
  • 终端权限与文件权限
  • 查看、收紧和撤销 grant
  • 更换手机、设备丢失与凭据泄露处理
  • 配对失败、时钟偏差和过期 claim 排查

先阅读扫码配对。

8. 文件管理与在线预览

  • 文件根目录与最小权限配置
  • 浏览、搜索、新建、重命名和删除
  • 上传、下载、取消与完整性校验
  • 从终端工作目录打开文件
  • 文本、文档、图片、媒体和 3D 文件预览
  • 大文件、网络中断和传输失败处理

先阅读文件管理。

9. AnyTTY Cloud

  • Cloud 解决的问题及其与开源客户端的关系
  • 注册、登录、设备发现与账号管理
  • P2P 协商、Relay 兜底和连接状态
  • Cloud 与 Local、SSH、Direct 的选择
  • 服务限制、用量、套餐与账单
  • 注销账号、移除设备与数据处理

先阅读AnyTTY Cloud。

10. 配置与日常运维

  • daemon 配置文件、启动参数与环境变量
  • 开机启动、停止、重启和状态检查
  • 历史记录、日志、缓存与磁盘占用
  • 文件根目录和访问策略维护
  • 备份、恢复与设备迁移
  • 性能、资源限制和长期运行建议

11. 安全与隐私

  • client、daemon、连接路由与 Cloud 的责任边界
  • 身份认证、传输加密与凭据存储
  • 配对 claim、grant 和撤销机制
  • Relay 能看到什么、不能获得什么权限
  • 终端内容、文件、日志和诊断信息的处理
  • 安全配置清单与漏洞报告流程

先阅读安全模型。

12. 故障排查

  • 安装后找不到命令或 daemon 无法启动
  • TUI 显示、键盘输入和终端尺寸异常
  • 手机无法扫码、配对或重新连接
  • SSH、Direct、P2P 或 Relay 连接失败
  • 文件列表、预览、上传或下载失败
  • 收集脱敏诊断信息并寻求支持

13. 常见问题

  • 关闭 TUI、停止任务和删除记录的区别
  • AI task 如何进入 terminal 池并接受管理
  • Cloud 登录、配对、route 与 Relay 的责任边界
  • 多客户端、resize ownership、history 和文件权限
  • 配置路径、运行时默认值和推荐配置的区别

14. 命令与配置参考

  • CLI 命令索引
  • daemon、terminal、endpoint、pair 和 file 命令
  • 配置文件字段与示例
  • 环境变量、默认端口和数据目录
  • 状态、错误码与日志字段
  • 平台支持矩阵、兼容性和术语表

15. 版本、支持与参与项目

  • Beta 稳定性承诺与已知限制
  • 发布说明、升级注意事项与兼容策略
  • 获取帮助、提交问题和功能建议
  • 隐私问题与安全漏洞报告
  • 从源码构建、贡献代码与贡献文档

开发者和贡献者可先阅读构建与贡献。