Ticketron

🚀 チケットロボット 使用ドキュメント

チケットロボットは、チケットの作成、検索、管理などのタスクを自動化するツールです。このドキュメントでは、チケットロボットのインストール、設定、基本的な使用方法、開発に関する情報を提供します。

📦 インストール

バイナリファイルのダウンロード

GitHub リポジトリ のリリースページから、お使いのオペレーティングシステムに適したバイナリファイルをダウンロードできます。

ソースコードからのビルド

ソースコードから ticketron をビルドする場合は、以下の手順に従ってください。

1. リポジトリをクローンします。

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

2. 依存関係をインストールします。

   go mod tidy
   

3. 実行可能ファイルをビルドします。

   make build
   

🛠️ 設定

設定の初期化

以下のコマンドを実行して、デフォルトの設定ファイルを初期化します。

tix config init

これにより、サンプルリンク、システムプロンプト、コンテキストを含む初期設定が作成されます。

APIキーの設定

以下のコマンドを使用して、OpenAI APIキーをオペレーティングシステムのキーチェーンに安全に保存します。

tix config set-key your-api-key-here

💻 使用例

チケットの作成

サンプルコマンド

• 簡単なエラーレポートを作成します。

  tix create bug "ログインページの読み込みが遅い"
  

• プロジェクトごとにストーリータイプを作成します。

  tix create --type Story --project WEB "ユーザープロフィールページの新しいデザインを実装する"
  

• 説明付きのタスクを作成します（大規模言語モデルによって処理されます）。

  tix create task "認証モジュールをJWTを使用するようにリファクタリングする" --description "現在のセッション管理は古くなっています。安全性と拡張性を向上させるために、JWTに切り替える必要があります。ログイン、ログアウト、トークンリフレッシュエンドポイントを更新します。"
  

• 対話式で作成します（送信前に確認を求められます）。

  tix create -i bug "設定ページのUIエラー"
  

• チケットを作成し、結果をJSON形式で出力します。

  tix create task "CIパイプラインを構成する" -o json
  

チケットの検索

サンプルコマンド

• 自然言語で検索します（大規模言語モデルによってJQLが生成されます）。

  tix search "WEBプロジェクトで未解決のエラー"
  

• 明示的なJQLで検索します。

  tix search --jql "project = WEB AND status = '進行中' ORDER BY created DESC"
  

• 現在のユーザーに割り当てられた未解決のチケットを検索します。

  tix search --jql "assignee = currentUser() AND resolution = Unresolved"
  

• 検索結果をJSON形式で出力します。

  tix search "私の未完了のタスク" -o json
  

• 指定したフィールドをJSON形式で出力します。

  tix search "status = 完了" -o json -f key,fields.summary,fields.status.name
  

• YAML形式で出力します。

  tix search "私の未完了のタスク" -o yaml
  

• TSV（タブ区切り値）形式で出力します。

  tix search "project = API" -o tsv
  

• 指定したフィールドをTSV形式で出力します。

  tix search "project = API" -o tsv -f key,fields.issuetype.name,fields.summary
  

設定の管理

サンプルコマンド

• 現在の設定を表示します。

  tix config list
  

• 特定の設定値を更新します。

  tix config set key=your_new_api_key
  

🤖 大規模言語モデルのコンテキスト管理

コンテキストファイルの作成と編集

大規模言語モデルのコンテキストを ~/.config/ticketron/contexts/default.yaml ファイルに保存します。以下はサンプル内容です。

llm:
  model: gpt-3.5-turbo
  temperature: 0.7
  max_tokens: 2048

コンテキストの切り替え

以下のコマンドを使用して、異なる大規模言語モデルのコンテキストを切り替えます。

tix config set context=your_context_name

🚧 開発

ソースコードからの起動

1. リポジトリをクローンします。

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

2. 依存関係をインストールします。

   go mod tidy
   

3. 開発サーバーを起動します。

   make dev
   

コードの貢献

コミット規則

Conventional Commits 規則に従ってコミットしてください。

📝 ドキュメントの貢献者

• [あなたの名前またはチーム名]

チケットロボットをご利用いただき、ありがとうございます！何か問題があれば、FAQページ をご確認するか、GitHubリポジトリ で質問を投稿してください。