Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/rochacon/jiraya

Jiraya - Simple Jira CLI
https://github.com/rochacon/jiraya

cli jira productivity python

Last synced: 24 days ago
JSON representation

Jiraya - Simple Jira CLI

Awesome Lists containing this project

README

        

# jiraya - Simple Jira CLI

Jiraya is a simple CLI to deal with Jira issues.

## Commands

```shell
λ jiraya --help
jiraya - Simple Jira CLI.

Usage:
jiraya assign [] [--project=]
jiraya backlog [--project=]
jiraya comment [--project=]
jiraya comments [--project=]
jiraya doing [--user=] [--project=]
jiraya info [--project=]
jiraya move [] [--project=]
jiraya open [--project=]
jiraya review [--project=]
jiraya tasks [--project=]
jiraya todo [--project=]
jiraya unassign [--project=]
jiraya url
jiraya (-h | --help)
jiraya --version

Options:
-h --help Show this screen.
--version Show version.
-p --project= Jira project name. Also configurable with JIRA_DEFAULT_PROJECT environment variable.
```

## Configuration

Jiraya uses Basic Auth for authentication on Jira API. You'll need to export the following environment variables:

- `JIRA_URL`: This is your Jira instance base endpoint, such as: https://mycompany.atlassian.net. If you use Jira on premises, point this to your internal endpoint.
- `JIRA_USERNAME`: Your Jira username.
- `JIRA_PASSWORD`: Your Jira username.
- `JIRA_DEFAULT_PROJECT`: Jira default project. (Optional, all commands support `--project`)

## Working with Jiraya

My main workflow consists on:

1. Finding a planned issue to work on: `jiraya todo`
1. Assigning it to myself: `jiraya assign RO-42`
1. Moving the issue to "In progress": `jiraya move RO-42 "In Progress"`. Use `jiraya move RO-42` to list the available statuses.
1. Adding comments: `jiraya comment RO-42 "Jiraya is awesome"`
1. Moving to next status: `jiraya move RO-42 "Review"`
1. Repeat

## License

MIT