@cordbot/agent

中文文档
6.10.2发布于 2026/03/06MITES Module近 30 天下载 2640

Discord boot 由克洛德特工SDK供电

中文使用文档
文档目录16 节
  1. 概览
  2. 运行在自己的身上
  3. 先决条件
  4. Discord 瓶装设置
  5. 启动机器人
  6. 部署到Fly.io
  7. 项目结构
  8. 关键部件
  9. 捐款
  10. 发展 工作流量
  11. 代码样式
  12. 测试
  13. 捐助领域
  14. 警卫
  15. 许可证
  16. 支助

代码

一个开源的Discord bot 电源 克劳德 SDK特工 可以直接在您的 Discord 服务器中提供自动 AI 协助 .

访问 电话: 网络仪表板和文档.

概览

Cordbot 部署一个Claude代理, 监视您的 Discord 服务器, 维护对话记忆, 并帮助您的社区完成任务 。 带上你自己的 Claude API 密钥 并部署在自己的基础设施上 完全控制.

运行在自己的身上

先决条件

  1. Claude API 密钥 - 把钥匙拿来 control.harmanic.com (中文(简体) )
  2. 解析瓶 - 遵循以下设置指示

Discord 瓶装设置

  1. 创建 Discord 应用程序

    • 转到 Discord 开发者门户
    • 点击“ 新应用程序”
    • 给您的应用程序一个名称( 如 “ My Cordbot ” )
    • 单击“创建”
  2. 创建 Bot 用户

    • 在您的申请中, 请到左侧栏的“ 瓶子” 栏目
    • 点击“ 添加瓶” 确认
    • 在bot的用户名下,点击"Reset Token"以显示您的 bot 令牌
    • 安全地复制并保存此令牌 - 晚点再用
  3. 启用必要的意图

    • 向下滚动到“ 专用网关插件 ”
    • 启用 "意外的情节" (必须)
    • 启用 "服务会员" (必须)
    • 点击“ 保存更改”
  4. 获取您的 Bot 客户端 ID

    • 在"OAuth2"部分,找到您的"客户身份"
    • 复制此标识
  5. 请装瓶到您的服务器

    • 使用此邀请 URL, 替换 YOUR_CLIENT_ID 与您的机器人客户端身份:
    https://discord.com/api/oauth2/authorize?client_id=YOUR_CLIENT_ID&permissions=55370986941526&scope=bot
    
    • 在浏览器中打开 URL
    • 选择要添加机器人的服务器
    • 点击“ 授权”

    必需权限( 共18个) :

    • 常规:查看频道,管理频道,管理角色,踢出成员,禁入成员,管理事件,创建事件
    • 文本:发送信件,创建线索(公/私),在线索中发送,管理信件/线索,嵌入链接,附件文件,读取历史,添加反应,创建发售

启动机器人

用 npx 直接运行机器人 :

  1. 创建工作空间目录

    创建一个将作为机器人工作空间的空文件夹 :

    mkdir cordbot-workspace
    cd cordbot-workspace
    
  2. 设置环境变量

    创建一个 .env 此目录中的文件 :

    DISCORD_BOT_TOKEN=your-discord-bot-token
    DISCORD_GUILD_ID=your-server-id
    ANTHROPIC_API_KEY=your-anthropic-api-key
    
  3. 运行机器人

    npx @cordbot/agent
    

    关于地方发展的说明: 当运行你的本地机器上的机器人时,设置 HOME 用于当前目录的环境变量,以确保所有bot数据(配置、内存、通道)被扩展到您的工作空间:

    HOME=$(pwd) npx @cordbot/agent
    

    这使得机器人无法使用您系统的主目录,并保留您工作空间中包含的一切.

机器人将开始观察您的 Discord 服务器并回复信件 。 它将在这个工作空间目录中创建频道文件夹和配置文件.

部署到Fly.io

24/7行动,部署到 飞.io数字 :

  1. 创建工程目录

    mkdir cordbot-deploy
    cd cordbot-deploy
    
  2. 创建 Docker 文件

    创建名为的文件 Dockerfile数字 :

    FROM node:20-slim
    
    # Install additional tools that might be needed
    RUN apt-get update && apt-get install -y \
        sqlite3 \
        && rm -rf /var/lib/apt/lists/*
    
    # Set HOME to workspace for persistent ~/.claude/ directory
    ENV HOME=/workspace
    
    # Accept version as build argument
    ARG CORDBOT_VERSION=latest
    
    # Install cordbot package with specified version
    RUN npm install -g @cordbot/agent@${CORDBOT_VERSION}
    
    # Create workspace directory for persistent storage
    # Use the existing 'node' user from the base image (already UID 1000)
    RUN mkdir -p /workspace && chown node:node /workspace
    
    # Switch to non-root user
    USER node
    
    # Set working directory to the volume mount point
    # The volume will be mounted here, making it persistent
    WORKDIR /workspace
    
    # Run cordbot (will use /workspace as its workspace)
    CMD ["cordbot"]
    
  3. 创建 fly.toml 配置

    创建名为的文件 fly.toml数字 :

    app = "your-cordbot-name"
    primary_region = "iad"
    
    [build]
    
    [env]
      WORKSPACE_DIR = "/workspace"
    
    [mounts]
      source = "cordbot_data"
      destination = "/workspace"
    
    [[vm]]
      memory = '2gb'
      cpu_kind = 'shared'
      cpus = 1
    
  4. 与Fly CLI一起部署

    # Install Fly CLI
    brew install flyctl  # macOS
    # or: curl -L https://fly.io/install.sh | sh
    
    # Login to Fly
    fly auth login
    
    # Create volume for persistent storage
    fly volumes create cordbot_data --size 1
    
    # Set secrets
    fly secrets set DISCORD_BOT_TOKEN="your-token"
    fly secrets set DISCORD_GUILD_ID="your-guild-id"
    fly secrets set ANTHROPIC_API_KEY="your-api-key"
    
    # Deploy
    fly deploy
    

项目结构

使用 pnpm 工作空间管理 :

cordbot/
├── packages/
│   ├── bot/                    # Discord bot agent
│   │   ├── src/
│   │   │   ├── agent/          # Claude agent integration
│   │   │   ├── discord/        # Discord API adapter
│   │   │   ├── memory/         # Long-term memory system
│   │   │   ├── permissions/    # Permission management
│   │   │   └── index.ts        # Bot entry point
│   │   └── package.json
│   │
│   └── web-service/            # Web dashboard
│       ├── src/
│       │   ├── components/     # React components
│       │   ├── pages/          # Page components
│       │   ├── hooks/          # React hooks
│       │   └── firebase.ts     # Firebase config
│       └── package.json
│
├── package.json                # Root package.json
├── pnpm-workspace.yaml         # Workspace configuration
└── README.md                   # This file

关键部件

  • packages/bot/ - 运行克洛德特工的Discord机器人

    • Discord.js 服务器交互集成
    • Claude探员SDK的AI能力
    • 长期背景记忆系统
    • 敏感操作的许可系统
    • 自动任务的 Cron 调度器
  • packages/web-service/ - 用于配置的网络仪表板

    • 反应 + Vite + 类型脚本
    • 用于认证和储存的消防基地
    • Bot 设置和配置 UI
    • OAuth 服务整合

捐款

我们欢迎捐款! Cordbot是开放源代码,可以实现社区协作和透明度.

发展 工作流量

  1. 叉子存储器 关于 GitHub 的

  2. 创建特性分支

    git checkout -b feature/your-feature-name
    
  3. 做你的改变

    • 写入干净、可读代码
    • 遵循现有的代码样式
    • 添加新特性测试
    • 视需要更新文件
  4. 测试您的更改

    pnpm test
    pnpm build
    
  5. 提交更改

    git add .
    git commit -m "Description of your changes"
    
  6. 推到叉子边

    git push origin feature/your-feature-name
    
  7. 打开拉请求 关于 GitHub 的

代码样式

  • 类型安全使用类型脚本
  • 遵循现有的命名公约
  • 写入有意义的承诺信件
  • 保持功能重点和小功能
  • 注释复杂逻辑

测试

# Run all tests
pnpm test

# Run tests for specific package
pnpm --filter @cordbot/bot test
pnpm --filter @cordbot/web-service test

捐助领域

  • 新建 Discord API 集成
  • 额外的 OAuth 服务集成
  • 内存系统改进
  • 文件和实例
  • Bug 修正和性能改进

警卫

Cordbot运行时全系统访问,以提供克洛德的完整能力. 仅在有受控Discord访问权限的可信环境中使用. 从不共享认证符或承诺 .env 用于版本控制的文件.

许可证

麻省理工学院-见 自由主义 详情

支助

版本与发布记录

@cordbot/agent 共发布 74 个版本,首次发布于 2026/01/29;过去 12 个月发布了 74 个版本。

版本发布日期距今
6.10.2latest2026/03/068 个月前
6.10.12026/02/248 个月前
6.10.02026/02/238 个月前
6.9.02026/02/228 个月前
6.8.02026/02/218 个月前
6.7.02026/02/208 个月前

关于 @cordbot/agent 的常见问题

@cordbot/agent 是什么?

Discord boot 由克洛德特工SDK供电

如何安装 @cordbot/agent?

在项目目录运行 npm install @cordbot/agent,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 cordbot,可以用 npx cordbot 直接运行。

@cordbot/agent 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/cordbot__agent 是否存在。

@cordbot/agent 支持 ESM 还是 CommonJS?

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

@cordbot/agent 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=18.0.0。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@cordbot/agent 可以商用吗?

@cordbot/agent 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@cordbot/agent 的下载量有多少?

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

@cordbot/agent 还在维护吗?

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