@clisbot/server

中文文档
2.2.3发布于 2026/11/05TypeScriptES Module近 30 天下载 3257

Clisbot 后端服务器

中文使用文档
文档目录8 节
  1. 快速启动
  2. 建筑
  3. 发展
  4. 项目状况
  5. 环境变量
  6. 技术堆栈
  7. 测试
  8. 许可证

语音助理

语音控制终端助理,作为单一本地服务运行.

快速启动

# Install dependencies
npm install

# Copy environment variables
cp .env.example .env
# Edit .env and add your API keys (OpenAI, Deepgram)

# Run development servers
npm run dev

# Open browser to http://localhost:5173

建筑

  • 快捷服务器 (港口3000) - 服务于API并建设了UI生产
  • Vite Dev 服务器 (5173口) - 开发中的热-再装入 React UI
  • 网络安全套 (单位:千美元)/ws- 实时双向通信
  • 探员 - 装有终端控制装置的输油管
  • 守护进程 - 基于tmux的终端管理(进行中)

发展

# Run both servers (recommended)
npm run dev

# Or run separately:
npm run dev:server  # Express on port 3000
npm run dev:ui      # Vite on port 5173

# Type checking
npm run typecheck

# Build for production
npm run build

# Start production server
npm start

项目状况

++ 已完成 (第1-2阶段):

  • 软件包设置和配置
  • 带有 WebSocket 的快取服务器
  • 用 Vite 反应 UI
  • 有乒乓球测试的 WebSocket 客户端

执行中 (第3阶段):

  • 终端控制( tmux 集成)

计划数 (第4-9阶段):

  • LLM 整合( OpenAI GPT-4)
  • 经纪人
  • 语音对文本( 深色)
  • 文字对语言( OpenAI)
  • 音频流
  • UI 抛光

见 执行 PLAN.md 完整的细节.

环境变量

OPENAI_API_KEY=your-openai-key-here      # GPT-4 and TTS
DEEPGRAM_API_KEY=your-deepgram-key-here  # Streaming STT
STT_MODEL=whisper-1        # Optional: override to gpt-4o-transcribe, etc.
STT_CONFIDENCE_THRESHOLD=-3.0  # Optional: reject low-confidence clips
STT_DEBUG_AUDIO_DIR=.stt-debug # Optional: persist raw dictation audio for debugging
CLISBOT_HOME=~/.clisbot        # Runtime state directory (agents/, etc.)
CLISBOT_LISTEN=127.0.0.1:6868  # Listen address (host:port or /path/to/socket)

CLISBOT_HOME 默认为 ~/.clisbot 并隔离运行时的文物,如 agents/。 。 。 . CLISBOT_LISTEN 控制守护进程听取地址 。 对于蓝色/绿色测试,您可以在不触碰生产状态的情况下运行并行服务器:

CLISBOT_HOME=~/.clisbot-blue CLISBOT_LISTEN=127.0.0.1:7777 npm run dev

技术堆栈

  • 服务器:快取, TypeScript, ws (WebSocket)
  • 客户端: 反应 18, Vite, 类型脚本
  • 终端: tmux (通过子进程)
  • 大赦国际: OpenAI(LLM + TTS),深克(STT)

测试

目前通过:

  1. 启动服务器 : npm run dev
  2. 开放 http://localhost:5173
  3. 测试 WebSocket 连接( 绿色状态指标)
  4. 点击“ 发送平” 按钮测试通信

更多测试指南作为特点得以实施.

许可证

麻省理工学院

版本与发布记录

@clisbot/server 共发布 18 个版本,首次发布于 2026/10/10;过去 12 个月发布了 18 个版本。

版本发布日期距今
2.2.3latest2026/11/055 天前
2.2.22026/11/037 天前
2.2.12026/11/019 天前
2.2.02026/10/2714 天前
2.1.82026/10/2218 天前
2.1.72026/10/2219 天前

关于 @clisbot/server 的常见问题

@clisbot/server 是什么?

Clisbot 后端服务器

如何安装 @clisbot/server?

在项目目录运行 npm install @clisbot/server,或使用 pnpm add / yarn add / bun add。

@clisbot/server 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@clisbot/server 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@clisbot/server 可以商用吗?

@clisbot/server 使用 未声明 许可。package.json 没有声明许可证。没有许可证的代码默认保留全部权利,商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括,不构成法律意见,请以许可原文为准。

@clisbot/server 的下载量有多少?

根据 npm 官方下载统计,@clisbot/server 在 2026/10/10 – 2026/11/08 这 30 天内被下载 3,257 次,日均约 109 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@clisbot/server 还在维护吗?

最新版本 2.2.3 发布于 2026/11/05(5 天前);至今共发布 18 个版本,其中过去 12 个月发布了 18 个;首次发布于 2026/10/10。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。