TengitsCliBot PC Agent

Agent 进程，运行在用户的 PC 上，通过 WebSocket 连接到 Relay Server。

安装

全局安装（推荐）

npm install -g tengits-clibot-agent

从源码安装

git clone https://github.com/tengits/TengitsCliBot.git
cd TengitsCliBot/agent
npm install
npm run build
npm link

快速开始

1. 配置环境变量

创建配置文件 .tengits 或设置环境变量：

# Relay Server 地址
export RELAY_URL=ws://your-relay-server.com/ws

# 认证 Token（必须与 Relay Server 匹配）
export AUTH_TOKEN=your-auth-token

2. 启动 Agent

tca start

首次启动会提示输入用户名进行登录。

3. 创建本地终端会话

# 创建默认终端
tca terminal

# 创建命名终端
tca terminal my-work

终端后端选择策略：

1. 优先使用 node-pty（交互式终端，实时显示）
2. 降级到 tmux（如果 node-pty 不可用）
3. 失败提示（如果两者都不可用）

可用命令

tca start [username]             # 启动 agent（首次会提示登录）
tca logout                      # 登出（清除保存的 token）
tca terminal [session-id]        # 创建本地终端
tca help                        # 显示帮助

环境要求

• Node.js v18+ (推荐 v18.20.8)
• npm 或 yarn
• tmux (用于本地终端会话)

项目结构

agent/
├── src/              # 源代码
├── dist/            # 编译输出
├── bin/             # 命令行工具
├── scripts/         # 工具脚本
├── coverage/        # 测试覆盖率
├── package.json
└── tsconfig.json

配置

环境变量

主要配置：

• RELAY_URL: Relay Server 地址
• TERMINAL_BACKEND: 终端后端（auto/node-pty/tmux）
• AUTH_TOKEN: 认证 Token

配置文件

支持在项目根目录的 .tengits 或 settings.json 文件中配置。

注意事项

• Node.js v18 是使用 node-pty 的推荐版本
• Node.js v22 可能导致 node-pty 不兼容
• 如果 node-pty 不可用，会自动降级到 tmux

许可证

MIT