daan/jirac
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
A CLI for creating and managing Jira tickets directly from your terminal
19 commits 1 branch 0 tags 341 KiB
Rust 100%
Find a file
Daan Boerlage 21203eed43
Add the view command to the readme
2025-01-21 21:35:17 +01:00
src Add the view command to the readme 2025-01-21 21:35:17 +01:00
.gitignore Initial commit 2025-01-21 15:55:34 +01:00
Cargo.lock Rely on the crossterm crate rather than colored 2025-01-21 20:36:36 +01:00
Cargo.toml Rely on the crossterm crate rather than colored 2025-01-21 20:36:36 +01:00
readme.md Add the view command to the readme 2025-01-21 21:35:17 +01:00

readme.md

Jirac

A CLI for creating and managing Jira tickets directly from your terminal.

Features

  • Create Jira tickets from markdown files or using your preferred editor
  • List tickets assigned to specific users
  • Simple configuration using TOML
  • Interactive ticket creation with templates
  • Execute JQL

Installation

from crates.io

cargo install jirac

Usage

Usage: jirac <COMMAND>

Commands:
  create  Create an issue
  list    Find issues currently assigned to you
  search  Search for issues
  view    View an issue
  init    Set up the configuration
  help    Print this message or the help of the given subcommand(s)

Options:
  -h, --help     Print help
  -V, --version  Print version

Creating a ticket

Create a ticket

Usage: jirac create [OPTIONS] [MARKDOWN_FILE]

Arguments:
  [MARKDOWN_FILE]  A markdown file

Options:
      --project <PROJECT>  The project key in which to create the ticket
      --open               Open the new ticket in a browser
  -h, --help               Print help

Using your favourite editor

jirac create

From a markdown file

jirac create ticket.md

Specify a project

jirac create --project KEY

Listing tickets

Find tickets currently assigned to you

Usage: jirac list [OPTIONS]

Options:
      --json  Print json rather than pretty print
  -h, --help  Print help

Search for tickets

Search for issues

Usage: jirac search [OPTIONS] <JQL>

Arguments:
  <JQL>  A JQL string

Options:
      --json  Print JSON rather than pretty print
  -h, --help  Print help

Use JQL to search for Issues.

Find all in-progress tickets in a project

jirac search 'project = KEY AND status = "In Progress" ORDER BY created DESC'

View an issue

View an issue

Usage: jirac view [OPTIONS] <ISSUE>

Arguments:
  <ISSUE>  An issue key, for example, KEY-123

Options:
      --json  Print JSON rather than pretty print
  -h, --help  Print help

./target/release/jirac view KEY-123

Configuration

Get the following information:

Then run the jirac init command

Setup the configuration

Usage: jirac init --url <URL> --email <EMAIL> --token <TOKEN>

Options:
      --url <URL>      Jira instance URL
      --email <EMAIL>  User email
      --token <TOKEN>  User Token
  -h, --help           Print help

The config file is stored at:

OS Location
Windows ~/.config/jirac/config.toml
MacOS ~/Library/Application Support/com.runebaas.jirac/config.toml
Linux %APPDATA%\runebaas\jirac\config\config.toml