CLI聊天机器人

Bibble是一个基于TypeScript构建的命令行界面(CLI)聊天机器人应用,支持OpenAI、Anthropic和兼容OpenAI的API端点,实现实时响应流式传输,维护聊天记忆,并作为MCP客户端运行。

  • by pinkpixel-dev
  • TypeScript
  • 本地部署
  • 6 星标
  • 更新于
在 GitHub 查看 pinkpixel-dev/bibble

使用说明



Bibble-CLI聊天机器人与MCP集成

Bibble是一个基于TypeScript构建的命令行界面(CLI)聊天机器人应用程序,可以直接在您的终端中运行。它支持OpenAI、Anthropic和与OpenAI兼容的API端点,实现实时响应流,维护聊天内存,并用作MCP(模型上下文协议)客户端。

特性

  • 通过CLI命令作为聊天实例启动 bibble
  • 支持OpenAI、Anthropic(Claude模型)和与OpenAI兼容的API端点
  • 模型输出的实时响应流
  • 带聊天记忆的上下文多回合对话
  • 用于连接MCP兼容服务器的MCP客户端功能
  • 可从CLI访问的设置和配置选项
  • 详细的错误处理和用户反馈
  • 彩色文本输出和markdown渲染
  • 聊天历史存储和检索
  • 模型切换功能
  • 可配置的系统提示和用户指南

安装

先决条件

  • Node.js v16或更高版本
  • npm v7或更高版本

从npm安装

# Install the official package
npm install -g @pinkpixel/bibble

从源代码安装

  1. 克隆存储库
  2. 安装依赖项
    npm install
    
  3. 构建项目
    npm run build
    
  4. 全局安装
    npm install -g .
    

用法

安装后,您可以使用以下命令运行Bibble bibble。如果您安装了带有 @pinkpixel 范围,您也可以使用 npx @pinkpixel/bibble.

开始聊天

bibble

或

bibble chat

使用npx:

npx @pinkpixel/bibble

配置设置

bibble config

管理聊天记录

bibble history

命令

聊天命令

  • bibble chat -开始聊天会话
  • bibble chat --model gpt-4 -与特定模特开始聊天
  • bibble chat --continue -继续最近的聊天
  • bibble chat --history <id> -加载特定聊天记录

配置命令

  • bibble config list -列出所有配置设置
  • bibble config set <key> <value> -设置配置值
  • bibble config get <key> -获取配置值
  • bibble config reset -将配置重置为默认值
  • bibble config api-key -为提供程序设置API密钥
  • bibble config mcp-servers -管理MCP服务器配置
  • bibble config user-guidelines -配置用户指南

历史命令

  • bibble history list -列出聊天记录
  • bibble history show <id> -显示特定聊天记录
  • bibble history delete <id> -删除聊天记录
  • bibble history clear -清除所有聊天记录
  • bibble history export <id> <filename> -将聊天记录导出到JSON文件
  • bibble history import <filename> -从JSON文件导入聊天记录

聊天命令

聊天会话期间可以使用以下命令:

  • /help -显示帮助信息
  • /exit 或 /quit -退出聊天
  • /clear -清除屏幕
  • /save -将当前聊天记录保存到历史记录
  • /reset -重置当前对话

配置

Bibble将其配置存储在 .bibble 主目录中的目录。配置包括:

  • API密钥
  • 默认模型设置
  • 用户界面设置
  • MCP服务器配置
  • 用户指南(AI的附加说明)

MCP集成

Bibble作为MCP客户端运行,允许它连接到MCP兼容的服务器并使用它们的工具。MCP(模型上下文协议)是一种用于将语言模型连接到外部工具和服务的协议。

要配置MCP服务器,请使用:

bibble config mcp-servers

发展

项目结构

/
├── src/
│   ├── commands/         # CLI command handlers
│   ├── config/           # Configuration management
│   ├── mcp/              # MCP client implementation
│   ├── llm/              # LLM integration
│   ├── ui/               # Terminal UI components
│   ├── utils/            # Utility functions
│   ├── index.ts          # Main entry point
│   └── types.ts          # TypeScript type definitions
├── bin/                  # Binary executable
├── scripts/              # Helper scripts
├── package.json          # NPM package definition
└── tsconfig.json         # TypeScript configuration

构建项目

npm run build

手表开发模式

npm run dev

发布到npm

该包已发布到npm @pinkpixel 范围:

# Login to npm
npm login

# Build the project
npm run build

# Publish the package
npm publish --access public

要安装最新版本,请执行以下操作:

npm install -g @pinkpixel/bibble@latest

许可证

国际协调委员会