2017-09-25 15:45:01 -04:00
|
|
|
# jkl
|
2017-10-30 13:07:17 -04:00
|
|
|
jkl is a library for programmatically interacting with a JIRA installation. It
|
|
|
|
|
comes with a command line program (also called `jkl`) which allows you to
|
|
|
|
|
interact with JIRA via the command line.
|
2017-09-25 15:45:01 -04:00
|
|
|
|
|
|
|
|
## Installation
|
2017-10-30 13:14:23 -04:00
|
|
|
To use the library, simply import it into your application:
|
|
|
|
|
`import "github.com/otremblay/jkl"`
|
2017-09-25 15:45:01 -04:00
|
|
|
|
2017-10-30 13:14:23 -04:00
|
|
|
To install the command line application:
|
|
|
|
|
First, make sure you have a working go environment:
|
|
|
|
|
https://golang.org/doc/install
|
|
|
|
|
|
|
|
|
|
Then, execute the following command from your shell:
|
|
|
|
|
|
|
|
|
|
`$ go get github.com/otremblay/jkl/cmd/jkl`
|
2017-09-25 15:45:01 -04:00
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
2017-10-30 14:11:18 -04:00
|
|
|
Make sure you create a `~/.jklrc` file in your home directory, it should contain
|
|
|
|
|
at a minimum:
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
JIRA_ROOT="https://jira.example.com/"
|
|
|
|
|
JIRA_USER="myusername"
|
|
|
|
|
JIRA_PASSWORD="mypassword"
|
|
|
|
|
JIRA_PROJECT="DPK"
|
|
|
|
|
```
|
|
|
|
|
Those values are for example only, your setup will be different.
|
|
|
|
|
|
|
|
|
|
TODO: Finish writing usage instructions
|
2017-09-25 15:45:01 -04:00
|
|
|
|
|
|
|
|
## Contributing
|
|
|
|
|
|
|
|
|
|
1. Fork it!
|
|
|
|
|
2. Create your feature branch: `git checkout -b my-new-feature`
|
|
|
|
|
3. Commit your changes: `git commit -am 'Add some feature'`
|
|
|
|
|
4. Push to the branch: `git push origin my-new-feature`
|
|
|
|
|
5. Submit a pull request :D
|
