Ticketron (tix)

Ticketron (tix)

site icon
2025.04.18 0
GoJIRA助手命令行工具LLM集成交流协作开发效率
Ticketron(简称tix)是一个智能的JIRA命令行助手,利用大型语言模型(LLMs)技术,通过自然语言或简洁命令简化JIRA交互流程。它能够帮助用户快速创建和搜索JIRA工单,并自动添加上下文信息,从而提升工作效率。
View on GitHub

Overview

基本能力

产品定位

Ticketron是一个基于LLM技术的JIRA命令行工具,旨在简化开发者和团队在JIRA中的工单管理流程,提升工作效率。

核心功能

  • 工单创建:通过自然语言或命令创建JIRA工单(如tix create ...)。
  • 工单搜索:支持JQL查询或自然语言搜索工单(如tix search ...)。
  • 上下文生成:利用OpenAI的LLM自动添加工单上下文。
  • 配置管理:支持初始化、查看和设置配置(如tix config init|show|set-key)。
  • 安全存储:支持将API密钥存储在操作系统密钥链或环境变量中。
  • 上下文管理:支持查看、编辑和添加上下文(如tix context show|edit|add)。
  • Shell补全:支持Bash、Zsh、Fish和PowerShell的自动补全。
  • 结构化输出:支持JSON、YAML和TSV格式的输出。
  • 结构化日志:便于调试和问题追踪。

适用场景

  • 开发者快速创建和搜索JIRA工单。
  • 团队协作中简化工单管理流程。
  • 需要自动化添加工单上下文的场景。

工具列表

  • tix:主命令行工具,支持工单创建、搜索、配置管理等功能。
  • jira-mcp-server:用于与JIRA通信的后端服务。

常见问题解答

  • 如何设置OpenAI API密钥? 使用tix config set-key <your-openai-api-key>命令或设置环境变量TICKETRON_LLM_API_KEY
  • 如何初始化配置? 运行tix config init命令,生成默认配置文件。
  • 如何启用Shell补全? 使用tix completion [your-shell]生成补全脚本,并加载到Shell配置中。

使用教程

使用依赖

  • Go:版本1.23.8或更高。
  • jira-mcp-server:需运行实例。
  • OpenAI API密钥:用于LLM功能。
  • Make:用于开发任务。

安装教程

go install github.com/karolswdev/ticketron/cmd/tix@latest

确保$GOPATH/bin$HOME/go/binPATH中。

Shell补全设置

# Bash
tix completion bash
# Zsh
tix completion zsh
# Fish
tix completion fish
# PowerShell
tix completion powershell

调试方式

  1. 初始化配置bash tix config init
  2. 设置OpenAI API密钥bash tix config set-key <your-openai-api-key>
  3. 创建工单bash tix create bug "Login button unresponsive" --description "When clicking the login button on the main page, nothing happens."
  4. 搜索工单bash tix search "my open bugs in the WEB project"

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。