Taskboardai

🚀 タスクボード AI

軽量でファイルベースのタスク看板で、AIエージェント向けに設計されています。 人と機械の協調作業をサポートするWebインターフェースも備えています。

✨ 主な機能

AIX 機能

• JSONファイル保存：タスクデータをJSON形式でローカルファイルに保存します。
• MCPサーバー統合：Model Context Protocol (MCP) をサポートしており、Claude Code、Cursor、WindsurfなどのMCP対応ツールと連携できます。

ネットワーク機能

• 看板管理：コマンドラインまたはMCPエージェントを使って、看板の作成、更新、削除ができます。
• Webhook統合：Webhookをサポートし、リアルタイムのデータ同期とサービス統合を実現します。

📦 インストール

方法1：npmを使用する

1. ターミナルを開きます。
2. 以下のコマンドを実行します。

npm install taskboardai

3. インストールが完了したら、サービスを起動するためにターミナルで以下を実行します。

node_modules/.bin/taskboardai start

方法2：ソースコードからコンパイルする

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設定

🔧 技術詳細

本プロジェクトは、軽量でファイルベースのタスク看板システムで、AIエージェントとの協調作業をサポートします。JSONファイルにタスクデータを保存することで、シンプルかつ柔軟なデータ管理を実現しています。また、MCPサーバーとの統合やWebhookを利用したリアルタイムデータ同期機能を備えており、様々なツールとの連携が可能です。

📄 ライセンス

Apache License 2.0 - 詳細は LICENSE を参照してください。

貢献ガイド

貢献を歓迎します！具体的なガイドは CONTRIBUTING.md を参照してください。