Cortex

🚀 Cortex フレームワークドキュメント

Cortex フレームワークは、多様な通信プロトコルをサポートし、カスタムツールの作成や多プロトコルの同時実行、強力なプラグインシステムを備えています。

🚀 クイックスタート

このセクションでは、Cortex フレームワークの基本的な使い方を紹介します。

✨ 主な機能

Cortex は、以下のような多様な通信プロトコルをサポートしています。

• STDIO プロトコル
• HTTP プロトコル（Server - Sent Events 技術を統合）
• TCP プロトコル
• WebSocket プロトコル

📦 インストール

この README ではインストール手順に関する具体的な内容が記載されていないため、このセクションは省略します。

💻 使用例

基本的な使用法

カスタムツールの作成

pkg/tools パッケージを使用することで、簡単にカスタムツールを作成および管理できます。

package main

import (
    "context"
    "log"

    "github.com/FreePeak/cortex/pkg/server"
    "github.com/FreePeak/cortex/pkg/tools"
)

func main() {
    // 基礎サービスコンテキストを作成
    ctx := context.Background()

    // サーバーを初期化
    srv := server.NewServer(ctx, &server.Config{
        Name: "私のカスタムツール",
        Desc: "これはデモ用のカスタムツールです",
        Tools: []*tools.Tool{
            {
                Name:    "echo",
                Desc:    "エコー機能",
                Handler: echoHandler,
            },
        },
    })

    // サーバーを起動
    if err := srv.ServeStdio(); err != nil {
        log.Fatal("サーバーの起動に失敗しました:", err)
    }
}

func echoHandler(ctx context.Context, req *server.Request) (*server.Response, error) {
    return &server.Response{
        Body: req.Body,
    }, nil
}

高度な使用法

多プロトコル同時実行

複数のプロトコルを同時に使用するサーバーを簡単に実装できます。

package main

import (
    "context"
    "log"
    "os"
    "syscall"

    "github.com/FreePeak/cortex/pkg/server"
)

func main() {
    ctx := context.Background()
    srv := server.NewServer(ctx, &server.Config{
        Name: "多プロトコルデモサーバー",
        Desc: "複数のプロトコルを同時に使用する方法を示します",
    })

    // HTTP サービスを起動
    go func() {
        if err := srv.ServeHTTP(":8080"); err != nil {
            log.Fatalf("HTTP サービスの起動に失敗しました:", err)
        }
    }()

    // STDIO サービスを起動
    go func() {
        if err := srv.ServeStdio(); err != nil {
            log.Fatalf("STDIO サービスの起動に失敗しました:", err)
        }
    }()

    // 終了信号を待つ
    stopChan := make(chan os.Signal, 1)
    signal.Notify(stopChan, os.Interrupt, syscall.SIGTERM)
    <-stopChan

    // サーバーを安全にシャットダウン
    ctxShutdown, cancel := context.WithTimeout(context.Background(), 10*time.Second)
    defer cancel()
    if err := srv.Shutdown(ctxShutdown); err != nil {
        log.Fatalf("サーバーのシャットダウンに失敗しました:", err)
    }
}

プラグインシステム

Cortex は強力なプラグイン拡張機構を提供しています。

package main

import (
    "context"

    "github.com/FreePeak/cortex/pkg/plugin"
)

type MyPlugin struct {
    *plugin.BasePlugin
}

func NewMyPlugin(logger *log.Logger) (*MyPlugin, error) {
    pluginInfo := &plugin.ProviderInfo{
        ID:          "my-plugin-id",
        Name:        "私のプラグイン名",
        Version:     "1.0.0",
        Description: "これはデモ用のプラグインです",
        Author:      "あなたの名前",
        URL:         "https://github.com/yourusername/myplugin",
    }

    basePlugin := plugin.NewBasePlugin(pluginInfo, logger)
    return &MyPlugin{
        BasePlugin: basePlugin,
    }, nil
}

📚 ドキュメント

貢献ガイド

Cortex への貢献を歓迎します！以下の手順に従って貢献してください。

1. コードリポジトリの作成
   プロジェクトリポジトリをあなたのアカウントに Fork してください。
2. 変更の提出
   あなた自身のブランチで変更を加え、コーディング規約に従ってください。
3. プルリクエストの提出
   メインリポジトリに Pull Request を提出し、詳細な説明を添えてください。
4. 議論への参加
   メンテナのコメントに返信し、フィードバックに基づいてコードを調整してください。

貢献者リスト

• John Doe - 初期プロジェクト作成者
• Jane Smith - コア開発メンバー
• Bob Johnson - プラグインシステムの主要貢献者

ドキュメントの履歴

• v1.0.0 - 2023年10月：STDIO と HTTP サポートを含む初期バージョンがリリースされました。
• v1.1.0 - 2023年11月：TCP と WebSocket サポートが追加されました。
• v1.2.0 - 2024年1月：プラグインシステムの機能が改善されました。

ヘルプの取得

使用中に問題が発生した場合は、以下の方法でヘルプを取得できます。

• メールサポート: framework - support@freepeak.org
• GitHub の問題追跡: https://github.com/FreePeak/cortex/issues

インターフェースドキュメント

完全な API ドキュメントは以下のアドレスで参照できます。 https://pkg.go.dev/github.com/FreePeak/cortex

🔧 技術詳細

この README では技術的な詳細に関する具体的な内容が十分に記載されていないため、このセクションは省略します。

📄 ライセンス

この README ではライセンス情報が記載されていないため、このセクションは省略します。