Ticketron

🚀 Ticket Robot Usage Documentation

The Ticket Robot is a tool designed to simplify ticket management, offering functions such as ticket creation, search, and configuration management.

🚀 Quick Start

📦 Installation

Download Binary Files

You can download the binary files suitable for your operating system from the release page of the GitHub repository.

Build from Source Code

If you wish to build ticketron from the source code, you can follow these steps:

1. Clone the repository:

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

2. Install dependencies:

   go mod tidy
   

3. Build the executable file:

   make build
   

⚙️ Configuration

Initialize Configuration

Run the following command to initialize the default configuration file:

tix config init

This will create an initial configuration containing example links, system prompts, and context.

Set API Key

Use the following command to securely store your OpenAI API key in the operating system's keychain:

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

💻 Usage Examples

🔍 Create Tickets

Example Commands

• Create a simple bug report:

  tix create bug "The login page loads slowly"
  

• Create a story type by project:

  tix create --type Story --project WEB "Implement the new design of the user profile page"
  

• Create a task with a description (to be processed by the large language model):

  tix create task "Refactor the authentication module to use JWT" --description "The current session management is outdated. We need to switch to JWT to improve security and scalability. Update the login, logout, and token refresh endpoints."
  

• Interactive creation (prompt for confirmation before sending):

  tix create -i bug "Interface error on the settings page"
  

• Create a ticket and output the result in JSON format:

  tix create task "Configure the CI pipeline" -o json
  

🔎 Search Tickets

Example Commands

• Search using natural language (processed by the large language model to generate JQL):

  tix search "My unresolved bugs in the WEB project"
  

• Search using explicit JQL:

  tix search --jql "project = WEB AND status = 'In Progress' ORDER BY created DESC"
  

• Search for unresolved tickets assigned to the current user:

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

• Search and output results in JSON format:

  tix search "My incomplete tasks" -o json
  

• Specify fields and output in JSON format:

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

• Output in YAML format:

  tix search "My incomplete tasks" -o yaml
  

• Output in TSV (Tab-Separated Values) format:

  tix search "project = API" -o tsv
  

• Specify fields and output in TSV format:

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

🛠️ Manage Configuration

Example Commands

• Display the current configuration:

  tix config list
  

• Update a specific configuration value:

  tix config set key=your_new_api_key
  

🧠 Large Language Model Context Management

Create and Edit Context Files

Store your large language model context in the ~/.config/ticketron/contexts/default.yaml file. Here is an example content:

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

Switch Context

Use the following command to switch between different large language model contexts:

tix config set context=your_context_name

🛠️ Development

Start from Source Code

1. Clone the repository:

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

2. Install dependencies:

   go mod tidy
   

3. Start the development server:

   make dev
   

Contribute Code

Commit Specification

Follow the Conventional Commits specification for commits.

📝 Documentation Contributors

• [Your Name or Team Name]

Thank you for using the Ticket Robot! If you have any questions, please feel free to check our FAQ page or raise an issue on the GitHub repository.