Taskboardai

🚀 任务板 AI

任务板 AI 是一个轻量级、基于文件的任务看板，专为 AI 代理设计，还配备了用于人机协作的网络界面，能有效提升任务管理的效率。

✨ 主要特性

AIX 功能

• JSON 文件存储：将任务数据以 JSON 格式保存在本地文件中，便于数据的存储和管理。
• MCP 服务器集成：支持 Model Context Protocol (MCP)，可与支持 MCP 的工具（如 Claude Code、Cursor、Windsurf）配合使用，拓展了系统的兼容性和功能性。

网络功能

• 看板管理：通过命令行或 MCP 代理创建、更新和删除看板，操作便捷灵活。
• Webhook 集成：支持 Webhooks，实现实时数据同步与服务集成，让信息传递更加及时高效。

📦 安装指南

方式一：使用 npm

1. 打开终端。
2. 运行以下命令进行安装：

npm install taskboardai

3. 安装完成后，在终端运行以下命令启动服务：

node_modules/.bin/taskboardai start

方式二：从源代码编译

1. 克隆仓库：

git clone https://github.com/yourusername/taskboardai.git
cd taskboardai

2. 安装依赖：

npm install

3. 启动服务：

npm start

💻 使用示例

基本用法

• 列出所有看板：

taskboardai list

• 创建新看板：

taskboardai create --name "项目 X"

• 打开指定看板：

taskboardai open --name "项目 X"

• 删除看板：

taskboardai delete --name "项目 X"

高级用法

• MCP 代理控制：
  • 启动 MCP 服务器：

taskboard-mcp start

• 同时启动看板服务和 MCP 服务器：

taskboard-all start

• Webhook 配置：
  • 添加 Webhook：

taskboardai webhook add --url "https://example.com/webhook"

• 测试 Webhook 连接状态：

taskboardai webhook test --id 1

📚 详细文档

看板数据结构

看板数据以 JSON 格式存储，包含以下字段：

{
  "名称": "项目 X",
  "任务列表": [
    {
      "标题": "完成需求分析",
      "描述": "收集并整理用户需求文档",
      "优先级": "高",
      "状态": "进行中",
      "开始时间": "2023-10-01",
      "截止时间": "2023-10-15"
    }
  ],
  "下一步计划": [
    "评审需求文档",
    "分配开发任务"
  ],
  "最后更新时间": "2023-10-05T18:30:00Z"
}

测试

执行所有测试

npm test

生成覆盖报告

npm run test:coverage

监视模式运行测试

npm run test:watch

按类别运行测试

• 仅运行 MCP 服务器测试：

npm test -- --testPathPattern 'tests/.*mcp'

• 仅运行单元测试：

npm test -- tests/unit

• 仅运行集成测试：

npm test -- tests/integration

文档生成

安装依赖（如未安装）

npm install

生成文档（输出目录为 docs/api）

npm run docs

数据存储位置

• Linux/macOS：~/.taskboardai/
• Windows：C:\Users\<username>\.taskboardai\

数据目录包含：

• boards/：你的看板 JSON 文件
• config/：配置文件
• webhooks/：Webhook 配置

🤝 贡献指南

欢迎贡献！请参考 CONTRIBUTING.md 获取具体指导。

📄 许可证

本项目采用 Apache License 2.0 许可协议，具体内容见 LICENSE。