Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/willis7/jiractl

'jiractl' is short for Jira Controller.
https://github.com/willis7/jiractl

Last synced: 1 day ago
JSON representation

'jiractl' is short for Jira Controller.

Awesome Lists containing this project

README

        

# Jiractl

'jiractl' is short for Jira Controller.

## Status
[![Build Status](https://travis-ci.org/willis7/jiractl.svg?branch=master)](https://travis-ci.org/willis7/jiractl)
[![codecov](https://codecov.io/gh/willis7/jiractl/branch/master/graph/badge.svg)](https://codecov.io/gh/willis7/jiractl)

## Usage
```
$ jiractl help

Jiractl is a CLI for Jira housekeeping tasks.
Jiractl uses the REST API to control your instance and execute
common tasks.

Usage:
jiractl [command]

Available Commands:
close Close issues that have not been actioned since warning.
help Help about any command
nudge Prompt issue watchers to action their tickets.

Flags:
--config string config file (default is $HOME/.jiractl.yaml)
-d, --dry-run No operation dry run
-h, --help help for jiractl
--pass string JIRA Password.
-t, --toggle Help message for toggle
--url string JIRA instance URL (format: scheme://[username[:password]@]host[:port]/).
--user string JIRA Username.

Use "jiractl [command] --help" for more information about a command.
subcommand is required
```

### Config

This CLI supports the use of a configuration file for persisting connection details.

Example `.jiractl.yml`

``` yaml
---
url: "https://mydomain.atlassian.net/"
user: "[email protected]"
pass: "DYPMYSUPERSECRETPASSWORDKEYTHINGYE20"
```

## Development

See the [Makefile](Makefile) for a complete list of commands.

``` bash
$ export TESTARGS="--url=scheme://[username[:password]@]host[:port]/"
# test runs the unit tests
$ make test

# testrace runs the race checker
$ make testrace

# dev creates binaries for testing Jiractl locally. These are put
# into ./bin/ as well as $GOPATH/bin
$ make dev
```