Ticketron

🚀 票據機器人 使用文檔

票據機器人 ticketron 是一款強大的工具，可幫助你高效地創建、搜索和管理票據。它支持從二進制文件下載和源碼構建，還能與 OpenAI 集成，通過大語言模型處理自然語言查詢。

🚀 快速開始

安裝

你可以選擇下載二進制文件或從源碼構建 ticketron。

下載二進制文件

你可以從 GitHub 倉庫 的發佈頁面下載適用於你操作系統的二進制文件。

從源碼構建

如果你希望從源代碼構建 ticketron，可以按照以下步驟操作：

# 克隆倉庫
git clone https://github.com/yourusername/ticketron.git
cd ticketron

# 安裝依賴項
go mod tidy

# 構建可執行文件
make build

配置

在使用 ticketron 之前，你需要進行一些配置。

初始化配置

運行以下命令初始化默認配置文件：

tix config init

這將創建一個包含示例鏈接、系統提示和上下文的初始配置。

設置 API 密鑰

使用以下命令將 OpenAI API 密鑰安全地存儲在操作系統的密鑰鏈中：

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

✨ 主要特性

• 多種票據操作：支持創建、搜索和管理票據，涵蓋多種票據類型。
• 自然語言處理：藉助大語言模型處理自然語言查詢，生成 JQL 進行搜索。
• 上下文管理：可創建和切換不同的大語言模型上下文。
• 多格式輸出：支持將創建和搜索票據的結果輸出為 JSON、YAML 和 TSV 格式。

📦 安裝指南

下載二進制文件

從 GitHub 倉庫 的發佈頁面，選擇適合你操作系統的二進制文件進行下載。

從源碼構建

# 克隆倉庫
git clone https://github.com/yourusername/ticketron.git
cd ticketron

# 安裝依賴項
go mod tidy

# 構建可執行文件
make build

💻 使用示例

基本用法

創建票據

• 創建一個簡單的錯誤報告：

tix create bug "登錄頁面加載緩慢"

• 按項目創建故事類型：

tix create --type Story --project WEB "實現用戶資料頁面新設計"

• 帶描述的任務創建（將由大語言模型處理）：

tix create task "重構身份驗證模塊以使用 JWT" --description "當前會話管理已過時。我們需要切換到 JWT 以提高安全性和可擴展性。更新登錄、註銷和令牌刷新端點。"

• 交互式創建（提示確認前發送）：

tix create -i bug "設置頁面上的界面錯誤"

• 創建票據並輸出結果為 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

大語言模型上下文管理

創建和編輯上下文文件

將你的大語言模型上下文存儲在 ~/.config/ticketron/contexts/default.yaml 文件中。以下是一個示例內容：

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

切換上下文

使用以下命令切換不同的大語言模型上下文：

tix config set context=your_context_name

🔧 技術細節

從源碼啟動

如果你想從源碼啟動 ticketron，可以按以下步驟操作：

# 克隆倉庫
git clone https://github.com/yourusername/ticketron.git
cd ticketron

# 安裝依賴項
go mod tidy

# 啟動開發服務器
make dev

貢獻代碼

提交規範

遵循 Conventional Commits 規範進行 commits。

📄 許可證

文檔中未提及相關許可證信息。

感謝使用票據機器人！如果有任何問題，請隨時查看我們的 FAQ 頁面 或在 GitHub 倉庫 上提出問題。

文檔貢獻者

• [你的名字或團隊名稱]