# logwork

> Command line utility to manage Jira worklogs for you.

Latest version **1.1.2** (published 2016-06-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install logwork
pnpm add logwork
yarn add logwork
bun add logwork
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.2 |
| Published | 2016-06-23 |
| First published | 2016-06-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Anders Weijnitz |
| Maintainers | aweijnitz |
| Keywords | Jira, worklog, time-tracking |

## Links

- npm: https://www.npmjs.com/package/logwork
- npm.io page: https://npm.io/package/logwork

## Dependencies (1)

- [commander](https://npm.io/package/commander.md) ^2.9.0

## Alternatives

- [cli-color](https://npm.io/package/cli-color.md) — 3.4M weekly downloads
- [log](https://npm.io/package/log.md) — 1.3M weekly downloads
- [logstash-client](https://npm.io/package/logstash-client.md) — 4.5K weekly downloads
- [@nocobase/plugin-logger](https://npm.io/package/@nocobase/plugin-logger.md) — 2.0K weekly downloads
- [child-process-debug](https://npm.io/package/child-process-debug.md) — 695 weekly downloads

## Recent versions

- 1.1.2 (latest) — 2016-06-23
- 1.1.0 — 2016-06-23

## README

# LogWork - A command line utility for easy jira work logging

## Motivation
Sometimes it can be difficult to track time to dedicated Jira tickets when working on multiple issues, 
all relating to a single feature. This is where LogWork comes in handy. It lets you simply specify a 
number of hours to distribute and a list of tickets to distribute them on. LogWork will take care of the rest.


## Installation

1. Install [jira-cmd](https://github.com/germanrcuriel/jira-cmd#readme) and set it up (user/password, etc). ```npm install -g jira-cmd```
2. ```npm install -g logwork```


## How to use

__Log 6 hours randomly to the three given tickets, adding comments from the given file__
```bash
# Note! A ticket might get zero hours on a given day. If so, it will be ignored and not logged to jira.
$ logwork -c ./example/comments.txt 6 TICKET-A TICKET-B TICKET-C  
```
__Dry Run Mode! Same thing as above, but just list the commands, do nothing__
```bash
$ logwork -c ./example/comments.txt 6 TICKET-A TICKET-B TICKET-C
```

__Diplay usage info__
```bash
$ logwork -h 
$ logwork --help
```

__(Optional) Including your own worklog comments__

1. Create a file with comments to pick from. See [example](./example/comments.txt). Comments must be separated by line breaks.
2. Use the ```-c``` option and point to the file. LogWork will pick randomly form the comments and include them in the worklog.

_Example_
```bash
$ logwork -c ./example/comments.txt 6 TICKET-A TICKET-B TICKET-C
```


## How it works
The supplied number of hours will be randomly distributed over the list of tickets given. For each ticket with 
more than zero hours to it, jira-cmd will be invoked with the _worklogadd_ command.

```bash
# Example of the type of commands that will be created and run
$ jira worklogadd TICKET-A 2
or
$ jira worklogadd TICKET-B 1 "Refactoring and implementation"
```

## Releasing a new version

1. Make sure working directory is clean and everyting is checked in.
2. Update the version ```npm version minor -m "Comment here"```. [More details](https://docs.npmjs.com/cli/version).
3. Publish the new version ```npm publish```. [More details](https://docs.npmjs.com/getting-started/publishing-npm-packages)

---
_Source: https://npm.io/package/logwork · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._