Giter VIP home page Giter VIP logo

jirax's Introduction

jirax

forthebadge forthebadge forthebadge forthebadge

Build Status npm npm made with nodejs styled with prettier license PRs Welcome

โญ If you are using this tool or you like it, Star on GitHub โ€” it helps!

A CLI tool for 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 installed to run the cli tool or after installing Node.js you can make executable and run the excutable to use the tool. Make executable

Getting Started

  1. Log in to Atlassian and generate your API TOKEN.
  2. Copy the API TOKEN

Install Using NPM

You can use directly install the package using NPM or YARN

 npm install -g jirax 
 yarn add jirax

use the below command to get started

 npx jirax

By Cloning the repository

Install all dependency

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.

jirax -l

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

$ 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

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

$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.

# prints all available commands
jirax --help 


For Subcommands options

 # 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

jirax logout

Making executable

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

 npm run build

Contribution

We hope that you will consider contributing to Jirax. Please read this short overview Contribution Guidelines for some information about how to get started

MIT License

jirax is available under the MIT license. See the LICENSE file for more info.

Copyright (c) 2021 [email protected]

jirax's People

Contributors

dependabot[bot] avatar junip avatar prashant-thorat avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

jirax's Issues

Support basic auth for non-Cloud JIRA

On-prem and self-hosted versions of JIRA do not have the feature to create JIRA tokens. It would be great if you were able to support auth via username and password as an option.

No way to list all open issues in a project?

As a team manager, I need to interact with issues other than just mine. It doesn't seem there is a way to list all open issues. Even better (for me at least) would be a way to list all issues in the current sprint (or all completed issues, all inreview issues, etc)

Describe the solution you'd like
A few ideas:
jirax list --all <projectKey>
jirax list --mine <projectKey> (default if no flags given)
jirax list --user <anyUserName> <projectKey>
jirax sprint --all <projectKey>
jirax sprint --mine <projectKey> (default if no flags given)
jirax sprint --user <anyUserName> <projectKey>
jirax completed --sprint <projectKey> (same as jirax completed --sprint --mine)
jirax completed --mine <projectKey>
jirax completed --user <anyUserName> <projectKey>
jirax completed --sprint --mine <projectKey>
jirax completed --sprint --user <anyUserName> <projectKey>

Describe alternatives you've considered
none that I can think of (other than just using the normal JIRA web interface)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.