jirest

jirest is a command line tool to use Jira REST API easily and interactively.

Installation

jirest is provided as docker image so you don't need to install any dependencies on your local machine.

1. Create jirest data directory under your $HOME.

   $ mkdir $HOME/.jirest
   

2. Now, you can use jirest with the following command.

   $ docker run -it --rm -v $HOME/.jirest:/root/jirest/data okamotoyuki/jirest
   

   We recommend you to add the following lines to your .bashrc.

   alias jirest='docker run -it --rm -v $HOME/.jirest:/root/jirest/data okamotoyuki/jirest'
   alias jirest-upgrade='docker rmi okamotoyuki/jirest:latest; docker pull okamotoyuki/jirest'
   

3. Run jirest init command to setup your Jira Cloud Base URL, username (email address), API token and your preferred editor for editing API request templates.

   $ jirest init
   

Usage

• Initialize jirest config.

  $ jirest init
  

• Show information of a Jira REST API.

  $ jirest describe [KEYWORD]
  

• Generate a curl command to use a Jira REST API.

  $ jirest dryrun [KEYWORD]
  

• Edit a request template for a Jira REST API. You can embed request parameters as {paramName}.

  $ jirest edit [KEYWORD]
  

• Revert a request template back to the default.

  $ jirest revert [KEYWORD]
  

• Execute a curl command to use a Jira REST API.

  $ jirest exec [KEYWORD]
  

• Describe available commands or one specific command.

  $ jirest help [COMMAND]
  

• Update all API definitions

  $ jirest update
  

• Reset all API definitions to the stable version.

  $ jirest reset
  

• Upgrade jirest to the latest version.

  $ jirest-upgrade
  

Development

After checking out the repo, run bin/setup to install dependencies. Then, run bundle exec rake test to run the tests.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/okamotoyuki/jirest. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the jirest project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.