Jira Oh-My-ZSH plugin
CLI support for JIRA & Git interaction
This plugin provides command line tools for interacting with Atlassian's JIRA bug tracking software.
The interaction is all done through the web. No local installation of JIRA is necessary.
In this document, "JIRA" refers to the JIRA issue tracking server, and
jira refers to the command this plugin supplies.
This plugin supplies one command,
jira, through which all its features are exposed. Most forms of this command open a JIRA page in your web browser.
jira # performs the default action jira git # opens an issue related to the current Git branch jira git m # opens an issue related to the current Git branch for adding a comment jira new # opens a new issue jira dashboard # opens your JIRA dashboard (alias: `jira dash`) jira reported [username] # queries for issues reported by a user jira assigned [username] # queries for issues assigned to a user jira ABC-123 # opens an existing issue jira ABC-123 m # opens an existing issue for adding a comment
These calling forms are for developers' use, and may change at any time.
jira dumpconfig # displays the effective configuration
Create folder inside your Oh-My-ZSH directory with custom plugins. Copy plugin files to it. Activate it in your ZSH config file. Usually it looks like:
cd ~/.oh-my-zsh/custom/plugins/ git clone firstname.lastname@example.org:igoradamenko/jira.plugin.zsh.git jira vim ~/.zshrc
In opened file find array
plugins and add
jira in it (or add whole line if it does not exist):
After that this custom plugin will override default
jira plugin from Oh-My-ZSH.
The URL for your JIRA instance is set by
$JIRA_URL or a
.jira-url file in the base of your project. You can also set
$JIRA_URL in your
~/.zshrc or put a
.jira-url in your home directory. A
.jira-url in the current directory takes precedence, so you can make per-project customizations.
The same goes with
$JIRA_PREFIX. These control the prefix added to all issue IDs, which differentiates projects within a JIRA instance.
cd to/my/project echo "https://jira.atlassian.com" >> .jira-url
(Note: The current implementation only looks in the current directory for
.jira-prefix, not up the path, so if you are in a subdirectory of your project, it will fall back to your default JIRA URL. This will probably change in the future though.)
$JIRA_URL- Your JIRA instance's URL
$JIRA_NAME- Your JIRA username; used as the default user for
$JIRA_PREFIX- Prefix added to issue ID arguments
$JIRA_RAPID_BOARD- Set to
trueif you use Rapid Board
$JIRA_DEFAULT_ACTION- Action to do when
jirais called with no arguments; defaults to
$JIRA_BRANCH_REGEX— Extended regular expression (ERE) for recognizing an issue code in a Git branch name; defaults to
Git branch recognition
jira git. So it will try to get issue code from the current Git branch name and open it.
$JIRA_BRANCH_REGEX in your
~/.zshrc to change the default recognition which accepts branches like these:
And so on. It means that the default pattern is
<string>-<issue code>-<string>, where
<string> is at least one symbol.
Your default web browser, as determined by how
http:// URLs, is used for interacting with the JIRA instance. If you change your system's URL handler associations, it will change the browser that