Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/junip/jirax

:sunglasses: :computer: Simple and flexible CLI Tool for your daily JIRA activity (supported on all OSes)
https://github.com/junip/jirax

cli jira jira-api-usage jira-cli jira-connector jira-issue jira-jql jira-plugin jira-rest-api jira-tickets jiraapiintegration jirarest node-cli

Last synced: about 2 months ago
JSON representation

:sunglasses: :computer: Simple and flexible CLI Tool for your daily JIRA activity (supported on all OSes)

Host: GitHub
URL: https://github.com/junip/jirax
Owner: junip
License: mit
Created: 2019-05-17T19:57:16.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2023-01-07T15:36:06.000Z (over 1 year ago)
Last Synced: 2024-08-03T19:22:27.520Z (about 2 months ago)
Topics: cli, jira, jira-api-usage, jira-cli, jira-connector, jira-issue, jira-jql, jira-plugin, jira-rest-api, jira-tickets, jiraapiintegration, jirarest, node-cli
Language: JavaScript
Homepage:
Size: 46.3 MB
Stars: 56
Watchers: 2
Forks: 3
Open Issues: 4
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

        # jirax

[![forthebadge](https://forthebadge.com/images/badges/made-with-javascript.svg)]() [![forthebadge](https://forthebadge.com/images/badges/built-with-love.svg)]() [![forthebadge](https://forthebadge.com/images/badges/for-you.svg)]() [![forthebadge](https://forthebadge.com/images/badges/check-it-out.svg)](https://forthebadge.com)

[![Build Status](https://dev.azure.com/junipd2/jirax/_apis/build/status/junipdewan.jirax?branchName=master)](https://dev.azure.com/junipd2/jirax/_build/latest?definitionId=4&branchName=master) ![npm](https://img.shields.io/npm/dm/jirax.svg) ![npm](https://img.shields.io/npm/v/jirax.svg) ![made with nodejs](https://img.shields.io/badge/madewith-node.js-green.svg) [![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier) [![license](https://img.shields.io/github/license/visionmedia/superagent.svg)](LICENSE) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=shields)](http://makeapullrequest.com)

```

```

> :star: If you are using this tool or you like it, Star on GitHub — it helps!

A CLI tool for [JIRA](`https://www.atlassian.com/software/jira`) for day to day usage with JIRA.Speed up your JIRA activity with this CLI tool.

## Prerequisites

You are required to have [Node.js](https://nodejs.org/) installed to run the cli tool or after installing [Node.js](https://nodejs.org/) you can make executable and run the excutable to use the tool. [Make executable](#making-executable)

## Getting Started

1. Log in to [Atlassian](https://id.atlassian.com/manage/api-tokens) and generate your API TOKEN.

2. Copy the API TOKEN

 

## Install Using NPM

You can use directly install the package using 

[NPM](https://www.npmjs.com/package/jirax)  or  [YARN](https://yarnpkg.com/en/package/jirax)

```sh

 npm install -g jirax 

```

```   

 yarn add jirax

```

### use the below command to get started

```sh

 npx jirax

```

## By Cloning the repository

Install all dependency 

```sh

npm install 

```

### Create the symlink. This command will help you execute `jirax` commands at global level 

```

npm link or sudo npm link

```

# Usages

## Login In Cli

 

You need to login before using any of JIRAX features.  

```sh

jirax -l

```

This will prompt few questions to enter your credentials please enter the credentials to use the CLI.)

```sh

$ Your JIRA Host Name (eg: something.atlassian.net)

$ Your JIRA User Name

$ Your API Token 

```

It will authenticate with JIRA Server and after successfull login, your name will prompt with message

![Interface](assets/login_preview.png?raw=true "Login Preview")

Your Login details will be stored in a JSON file located in 

```sh

$XDG_CONFIG_HOME or ~/.config.

# access it 

~/.config/configstore/jiraconfig.json

```

## JIRAX Commands

Jirax CLI tool is madeup with the subcommands for various jira activities.

```sh

# prints all available commands

jirax --help 

```






#### For Subcommands options

```sh

 # prints all available commands for a specific subcommand

 jirax command --help

```














## Clear Stored Credentials

In case of your API token revoked or you have revoked the previous API token then you need to clear the previous credentials using the following command and

Relogin using command `jirax login`

```sh

jirax logout

```

## Making executable

After cloning the repository. Run this command this command will automatically create plateform specific executables.

```sh

 npm run build

```

## Contribution

We hope that you will consider contributing to Jirax. Please read this short overview [Contribution Guidelines](https://github.com/junipdewan/jirax/blob/master/CONTRIBUTING.md) for some information about how to get started 

## MIT License

**jirax** is available under the **MIT license**. See the [LICENSE](https://github.com/junipdewan/jirax/blob/master/LICENSE) file for more info.

Copyright (c) 2021