Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nntoan/gojira

A PHP client for JIRA software, based on Symfony2 Components
https://github.com/nntoan/gojira

guzzle jira jira-rest-api php pimple symfony-console

Last synced: about 1 month ago
JSON representation

A PHP client for JIRA software, based on Symfony2 Components

Awesome Lists containing this project

README

        

GoJIRA, a PHP client for JIRA
================================================
[![SensioLabsInsight](https://insight.sensiolabs.com/projects/05f29fd2-39da-495f-bfe7-75acc7eba01a/mini.png)](https://insight.sensiolabs.com/projects/05f29fd2-39da-495f-bfe7-75acc7eba01a)
[![Build Status](https://img.shields.io/travis/nntoan/Gojira/master.svg)](https://travis-ci.org/nntoan/Gojira)
[![Coverage Status](https://img.shields.io/coveralls/nntoan/Gojira/master.svg)](https://coveralls.io/github/nntoan/Gojira?branch=master)
[![Code Quality](https://img.shields.io/scrutinizer/g/nntoan/Gojira.svg)](https://scrutinizer-ci.com/g/nntoan/Gojira/)
[![Latest Stable Version](https://img.shields.io/packagist/v/nntoan/gojira.svg?label=stable)](https://packagist.org/packages/nntoan/gojira)
[![Pre Release](https://img.shields.io/packagist/vpre/nntoan/gojira.svg?label=dev)](https://packagist.org/packages/nntoan/gojira)
[![Total Downloads](https://img.shields.io/packagist/dt/nntoan/gojira.svg)](https://packagist.org/packages/nntoan/gojira)
[![License](https://img.shields.io/packagist/l/nntoan/gojira.svg)](https://packagist.org/packages/nntoan/gojira)

GoJIRA is a PHP client for JIRA based on [Symfony2][1] components:

Gojira works with PHP 5.5.9 or later and is heavily inspired by the [Silex][2]
web micro-framework by Fabien Potencier.

## Why this name?

From JIRA team, I think it's funny :)

> Like all good names in the software industry, it started as an in-house code name.

> We originally used Bugzilla for bug tracking and the developers in the office started calling it by the Japanese name for Godzilla, Gojira (the original black-and-white Japanese Godzilla films are also office favourites). As we developed our own bug tracker, and then it became an issue tracker, the name stuck, but the Go got dropped - hence JIRA!

> Further investigation into the name has revealed that Gorira is Japanese for "gorilla", whilst Kujira is Japanese for "whale". So Gojira is roughly translated to mean "gorilla the size of a whale"! (Thanks to yusuke_arclamp — Oct 2002)

> For those who care - it sounds best if you yell it loudly, as though charging into battle. C'mon - try it!

## Installation

1. Downloads latest [GoJIRA][3].
(`wget -O /usr/local/bin/jira https://gojira.nntoan.com/get/gojira.phar`)
2. Make it executable `chmod +x /usr/local/bin/jira`

## Usage

##### First use

$ jira
Jira URL: https://jira.atlassian.com/
Username: john.doe
Password: xxxxxxxx

Your top secret information has been sent to our server successfully!

This save your credentials (base64 encoded) in your `$HOME/.gorira` folder.

##### Help

Usage: `jira [options] [command]`

Commands:

ls [options] List my issues
start Start working on an issue.
stop Stop working on an issue.
review [assignee] Mark issue as being reviewed [by assignee(optional)].
done [options] Mark issue as finished.
running List issues in progress.
jql Run JQL query
search Find issues.
assign [user] Assign an issue to . Provide only issue# to assign to me
comment [text] Comment an issue.
show [options] Show info about an issue
open Open an issue in a browser
worklogshow Show worklog about an issue
worklogadd [options] [comment] Log work for an issue
create [project[-issue]] Create an issue or a sub-task
config [options] Change configuration
sprint [options] Works with sprint boards
With no arguments, displays all rapid boards
With -r argument, attempt to find a single rapid board and display its active sprints
With both -r and -s arguments attempt to get a single rapidboard/ sprint and show its issues. If a single sprint board isnt found, show all matching sprint boards

Options:

-h, --help output usage information
-V, --version output the version number

Each command have individual usage help (using --help or -h)

##### Advanced options

Checkout ```~/.gorira/config.json``` for more options.

## License

GoJIRA is licensed under the [MIT license][5].

[1]: http://symfony.com
[2]: http://silex.sensiolabs.org
[3]: http://gojira.nntoan.com/get/gojira.phar
[4]: http://gojira.nntoan.com/documentation
[5]: LICENSE