票据机器人 使用文档

安装

下载二进制文件

你可以从 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 "设置页面上的界面错误"
  

• 创建票据并输出结果为 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 规范进行 commits。

文档贡献者

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

感谢使用票据机器人！如果有任何问题，请随时查看我们的 FAQ 页面 或在 GitHub 仓库 上提出问题。