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 仓库 上提出问题。

文档贡献者

• [你的名字或团队名称]