Skip to content

Commit

Permalink
Add documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
devashishTaneja committed Jul 6, 2023
1 parent 8cd50cc commit 4fd2ebf
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 7 deletions.
35 changes: 28 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,33 @@
go build -o out/jira main.go
out/jira <search_text>
# **JIRA CLI**

### Command Line Interface for Atlassian JIRA

[//]: # (Build steps)
go mod init github.com/devashishTaneja/jira-cli
go mod vendor
<img src="./img/jira.gif">

[//]: # (Go Releaser Setup)
### Features
1. [x] JIRA search
2. [x] JIRA navigation

### Installation
```shell
brew tap devashishTaneja/devashishTaneja
brew install devashishTaneja/devashishTaneja/jira
jira-cli <search query>

# Link to generate API Key for JIRA
# https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/
echo -ne '\nexport JIRA_DOMAIN=https://domain.atlassian.net' >> ~/.zshrc
echo -ne '\nexport JIRA_API_USER=username' >> ~/.zshrc
echo -ne '\nexport JIRA_API_KEY=apikey' >> ~/.zshrc


jira-cli < search query here :) >

```

### Development
```shell
go build -o out/jira main.go
out/jira <search_text>
go mod init github.com/devashishTaneja/jira-cli
go mod vendor
```
Binary file added img/jira.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 4fd2ebf

Please sign in to comment.