batrak

KO | EN

gitlite — search

#python #hacktoberfest #react #go #golang #android #machine-learning #rust #docker #nodejs #windows #awesome-list #pytorch #openai

(★ 11)

Console tool for managment Jira issues

batrak Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# batrak

Console tool for managment Jira issues

# Usage
![image](https://cloud.githubusercontent.com/assets/4948221/6000483/4a522496-aad6-11e4-84b2-5715c02af86d.gif)

First create configuration file in you home directory

```
vim ~/.batrakrc
```

and fill it with the following parameters

```toml
username = "JIRA_USERNAME"
password = "JIRA_PASSWORD"
jira_api_url = "http://JIRA.DOMAIN/rest/api/2"
project_name = "JIRA_PROJECT_NAME"
```

also, if you know filter ID in JIRA you may define it in config.

```
filter_id = JIRA_FILTER_ID
```

You may manually ordering print issues by status.
Just add following lines in you config with status and order description
```toml
[workflow]
  [[workflow.stage]]
    name = "In progress"
    order = 1
    kanban_order = 2
  [[workflow.stage]]
    name = "Analysis"
    order = 2
    kanban_order = 1
```

You can specify workflow configuration in separated file and then specify path
to this file using `--workflow <path>` flag. Workflow configuration in this
case will be without `workflow.` prefix:

```toml
[[stage]]
    name = "In progress"
    order = 1
    kanban_order = 2
[[stage]]
    name = "Analysis"
    order = 2
    kanban_order = 1
```

Batrak support hooks (pre_start, post_start, pre_stop, post_stop)
Hook - it just binary file or script that takes two string arguments:
* Jira issue Key - "TEST-100"
* Credential for connecting to JIRA API - "JIRA_USERNAME\x8EJIRA_PASSWORD\x8EJIRA_API_URL"

If you write you own hook, who does something with your issue, and you want use it after issue was stopped, 
add this lines in your config

```
[hooks]
post_stop = ["hook_name"]
```

### Commands

##### List 10 last issues assigne to JIRA_USERNAME
```
batrak -L
```

##### List 2 last issues assigne to JIRA_USERNAME
```
batrak -L --count=2
```

##### Show issue (Name, Status, Description)
```
batrak -L TEST-100
```

or if you watch issue in your JIRA_PROJECT_NAME

```
batrak -L 100
```

##### Show kanban (works if you describe your workflow in config file)
```
batrak -LK
```

##### Assign issue
```
batrak -A TEST-100
```

##### Show comments 
```
batrak -LC TEST-100
```

##### Write comment
```
batrak -C TEST-100
```

##### Remove comment
```
batrak -RC TEST-100 COMMENT_ID
```

##### Show available transitions for issue 
```
batrak -M TEST-100
```

##### Move issue 
```
batrak -M TEST-100 TRANSITION_ID
```

##### Start issue 
```
batrak -S TEST-100
```

##### Stop issue with logging work
```
batrak -T TEST-100
```

batrak

batrak Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

batrak

batrak Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README