Qissues is a CLI tool for interacting with various bug tracking systems. It's meant to provide a single, sane interface that is quick to use and can keep your hands on the keyboard. It's also heavily customizable to accomodate whatever workflow you have.
Qissues was inspired by Mylyn for Eclipse, but meant to assist people who prefer working with terminal applications rather than IDEs. Basically, quick read/write access to your issues without having to change programs.
The system is set up to help abstract and normalize the differences between various systems. It was modelled by looking at a handful of systems and researching even more. Therefore, adding new trackers shouldn't take too much work.
Currently supported:
- GitHub
- Bitbucket Issues
- Trello (Lists as Statuses)
- JIRA
- Query - Query your repository with various options, and see results in your terminal.
- Reports - Save common queries as reports so you can re-run them later. Ex:
qissues -r bugs - Views - Supports alternate views (large table view, smaller list with metadata, and tiny list). Automatically detects, but can be overridden.
- Post/Edit Issues - Submit and modify issues from comfort of your own terminal.
- Workflow Integration - For systems that support it, workflows (in progress -> resolved, prompting for resolution)
- Git Context - Easily query active issue based on branch name. "feature-x", would allow
qissues view,qissues edit, without remembering 'x'.
You can either download the latest release, or compile it yourself.
You can download the latest release from GitHub or from qissuescli.com. For the copy and pasters:
wget http://qissuescli.com/qissues.phar
chmod +x qissues.phar
mv qissues.phar ~/bin/qissues
This method will require PHP's phar.readonly setting to be enabled.
git clone https://github.com/AdrianSchneider/Qissues.git qissues
cd qissues
make && make install
Both of these methods will install qissues to ~/bin/qissues, which will require ~/bin in your $PATH.
Qissues operates by checking for a .qissues file in the root of a project. You can generate one via
qissues init
That will create the config file, ready for editing and with all of the tracker-specific options added as a reference. It's also advised to create a ~/.qissues file for credentials and non project-specific configurations. Be sure to add .qissues to your ~/.gitignore file to prevent accidentally committing it.
After configuring a project,
Query issues:
qissues [-r report [-s status [-t type [-a assignee [-k keyword [-l label [-o sortfield [--limit amt [--page num]]]]]]]]]
Will output something similar to:
+----+---------------------------------------------+----------+--------------------+
| Id | Title | Status | Date updated |
+----+---------------------------------------------+----------+--------------------+
| 1 | Dividing by zero upgrades PHP | new | 2013-11-03 7:01pm |
| 2 | Qissues doesn't work in Python | new | 2013-11-03 7:00pm |
| 3 | Insert coin here does not accept bitcoin | new | 2013-11-03 6:57pm |
| 4 | Working with JIRA is frustrating | resolved | 2013-04-16 2:36am |
+----+---------------------------------------------+----------+--------------------+
Save common queries to .qissues as reports.
View an Issue: Once you know what you're looking for, you can view more details:
qissues view 4
Create Issue: You can create new issues from Qissues many ways. The default launches $EDITOR with an empty frontmatter document.
qissues create
Looks like this...
---
title:
labels:
assignee:
---
Edit an Issue: Works similar to create, but pre-populated.
qissues edit 6
Looks like...
---
title: The Internet is DOWN!
assignee: AdrianSchneider
labels: emergency, lol
---
The internet is currently down. I cannot post TPS reports.
Save and close.
There is a lot more to learn in the Docs. Nearly every aspect is customizable or extendable, so take a peek.