https://github.com/jonrad/jql

https://github.com/jonrad/jql

Last synced: 3 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/jonrad/jql
• Owner: jonrad
• Created: 2022-08-15T00:43:55.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-08-28T22:55:22.000Z (over 2 years ago)
• Last Synced: 2024-11-05T07:42:04.001Z (about 2 months ago)
• Language: TypeScript
• Size: 87.9 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# jql

## Summary

Makes using JQL (Jira Query Language) a better experience from the command line

**Warning**

I made this tool for myself to simplify my life. It isn't intended to be shared, but I'm keeping it public in case someone wants to be inspired. Will it work on your computer? Maybe, but maybe not.

Features:

* Outputs Jira Issues in a format that is easier to use in templates

* Simplifies writing valid jql on the command line (bash/zsh) by enabling autocomplete and validating syntax

## Why?

Are you an engineer who who has to spend a lot of time in Jira? Do you prefer using the command line over using a UI? Wouldn't it be great if you can use all the same tools you're used to (`grep` comes to mind) when finding the Jiras that are pertinent to you? You could use this [amazing jira cli](https://github.com/ankitpokhrel/jira-cli) but then you have to memorize jql and typos are a pain, especially for us developers who are so used to code completion in our IDEs. This tool will enable jql code completion within your command line so that you can better use your tools and stay away from using clunky UIs.

Why waste time say lot word when few word do trick?

## Installing

```

npm install -g @yonrad/jql

# Add the following to your bashrc or zshrc (or run from command line to test as a one off)

source <(jql completion)

```

## Getting started

```

jql config # then follow prompts

```

## How to use

```

# The following will give you valid syntax to provide to anything that requires jql

jql assi = Jon

# Output:

# jql assignee = "Jon Radchenko"

```

### Example 1

```

jql --query assignedRecently assignee = Jon\ Radchenko and updatedDate \> -14d | head

```

Output:

```

{

  "assignedRecently": {

    "total": 34,

    // snip

    "issues": [

      {

        "fields": {

            // snip

            "myCustomField": "Foo"

        }

      },

      {

        // snip

      }

    ]

  }

}

```

### Example 2

```

jql --query assignedRecently 'assignee = "Jon Radchenko" and "updatedDate > -14d"'

# Output the same as above

```

### Example 3

```

jql --query assignedRecently 'assignee = "Jon Radchenko" and "updatedDate > -14d"' \

    --query anotherQuery 'assignee = "Someone Else" and "updatedDate > -14d"'

```

Output

```

{

  "assignedRecently": { ... },

  "anotherQuery": { ... }

}

```

## Using with [jira-cli](https://github.com/ankitpokhrel/jira-cli)

```

jira issue list --jql "$(jql assi = Jon AND statusC != Do)"

```