Welcome to Jira-Select’s documentation!

Jira-select is a command-line tool and library that helps you generate the useful insights you need out of Jira.

Jira has its own query language but there are many limitations around what JQL is capable of. Some data is returned in arcane formats (e.g. sprint names are returned as a string looking something like com.atlassian.greenhopper.service.sprint.Sprint@14b1c359[id=436...), data cannot be grouped (there’s nothing like SQL’s GROUP BY statement), and because of that lack of grouping, there are no aggregation functions – no SUM-ing story points or estimates per-assignee for you. And if you want to write a custom function for processing a field, well, I’m not even sure where you’d begin. Jira-select makes those things easy.

If you’ve ever found yourself held back by the limitations of Jira’s built-in query language, this tool may make your life easier. Using Jira-select you can perform a wide variety of SQL-like query operations including grouping, aggregation, custom functions, and more.

Contents:

• Quickstart
• Query Format
  • Query Structure Overview
    • What is a JqlString
    • What is an Expression
  • Ubiquitous
    • select
    • from
  • Common
    • where
    • order_by
    • group_by
    • having
    • sort_by
    • limit
    • cache
  • Unusual
    • expand
    • filter
    • cap
• How to
  • Use Functions
  • Format data using functions
  • Filter results using functions
  • Group results & calculate aggregates
  • Sort results using functions
  • Limit the number of returned results
  • Expand Jira Issue Fields
• Query Lifecycle
• Query Parameters
• Examples
  • Finding all issues assigned to a particular user
  • Summing the number of story points assigned in a particular sprint
  • Summing the total estimated size of issues per-person for a given sprint
  • Summing story points of issues resolved during a particular sprint
  • Summing worklog entries
• Command-Line
  • jira-select shell [–editor-mode=MODE] [–disable-progressbars] [–output=PATH] [–format=FORMAT] [–launch-default-viewer]
  • jira-select run FILENAME [–format=FORMAT] [–output=PATH] [–view] [–launch-default-viewer]
  • jira-select install-user-script SCRIPT [–overwrite] [–name]
  • jira-select build-query [–output=PATH]
  • jira-select configure
  • jira-select setup-instance
  • jira-select –instance-name=NAME remove-instance
  • jira-select show-instances [–json]
  • jira-select store-password USERNAME
  • jirafs-select functions [–having=EXPRESSION] [SEARCH_TERM [SEARCH_TERM…]]
  • jira-select schema [issues|boards|sprints] [–having=EXPRESSION] [SEARCH_TERM [SEARCH_TERM…]] [–json]
  • jira-select run-script FILENAME [ARGS…]
• Writing your own plugins
  • Commands
  • Functions
    • Direct Registration
    • Entrypoint
  • Formatters
• Troubleshooting
  • After running a query in jira-select’s shell subcommand, the output results are printed directly to the screen instead of opening in a spreadsheet viewer
  • Sometimes filtering using having (or sorting using sort_by) on a value I see in the output doesn’t work; why not?
  • I can’t connect because my Jira instance uses a self-signed certificate
  • When attempting to use a field’s human readable name in curly braces, I get a Parse Error
• Reference
  • Query Functions
    • Jira
    • Time Analysis
    • Data Traversal
    • Dates
    • Json
    • Math
    • Types
    • Sorting
    • Filtering & Mapping
    • Logic Shortcuts
    • Counting
    • Ranges
    • Random
  • API Reference
    • jira-select

Indices and tables

• Index

• Module Index

• Search Page