Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/michelml/jlog
Save jira worklogs from your terminal
https://github.com/michelml/jlog
clojure command-line commandline-tool jira leiningen terminal terminal-based timelog
Last synced: 24 days ago
JSON representation
Save jira worklogs from your terminal
- Host: GitHub
- URL: https://github.com/michelml/jlog
- Owner: MichelML
- License: mit
- Created: 2017-05-30T03:58:54.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2021-06-16T15:29:29.000Z (over 3 years ago)
- Last Synced: 2024-10-30T03:55:48.703Z (2 months ago)
- Topics: clojure, command-line, commandline-tool, jira, leiningen, terminal, terminal-based, timelog
- Language: Clojure
- Homepage:
- Size: 3.64 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# jlog
Save Jira worklogs from the terminal. Stop switching context. Stop relying on your memory.
The goal is to save your worklog as you do the actual work.
## Installation
Clone the repository locally.
```
git clone https://github.com/MichelML/jlog.git
```
Use an alias to point to the _jlog_ standalone jar in your `.bash_profile` file.
```
alias jlog="java -jar /target/jlog-0.1.0-SNAPSHOT-standalone.jar"
```
## Usage
Valid commands for _jlog_ are:
```
jlog -h - Prints the help menu to the console.
jlog -l - Prints your registered worklogs (contained in a file named jlog.txt) to the console.
jlog -o - Opens your jlog.txt file.
jlog -b - Writes a worklog to the jlog.txt file, retrieving the Jira issue key from your branch (see examples).
jlog - Writes a worklog to the jlog.txt file using the provided information.
```
## Examples
Log a full day for a specific Jira issue
```
jlog 1d TEST-12 "write your comment message here"
```
Log a full day OR hours and minutes
```bash
# valid commands
jlog 1d TEST-12 "write your comment message here"
jlog 2h30m TEST-12 "write your comment message here"
jlog 30m TEST-12 "write your comment message here"
jlog 2h TEST-12 "write your comment message here"
# invalid commands
jlog 1d1h TEST-12 "write your comment message here"
jlog 1d30m TEST-12 "write your comment message here"
```
Log for a specific Jira issue retrieved from a repository branch's name. Currently works for Mercurial (hg) repositories only.
```bash
# while in your repository, on a branch having a name containing a Jira issue key (ex: fix-TEST-123-specifics)
jlog -b 1h45m "write your comment message here"
```
Open your `jlog.txt` file at the end of the day and simply use the saved information to enter your worklogs in Jira.
```bash
# Opens your jlog.txt file
jlog -o
```
You can also print saved information in your terminal with the following command.
```bash
# Prints your jlog.txt content to the terminal
jlog -l
```