Code Monkey home page Code Monkey logo

jlog's Introduction

jlog

Build Status

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 <path to the jlog cloned repo>/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 <timelog> <message in quotes>              -     Writes a worklog to the jlog.txt file, retrieving the Jira issue key from your branch (see examples).
jlog <timelog> <issue key> <message in quotes>     -     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

# 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.

# 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.

# Opens your jlog.txt file  
jlog -o

You can also print saved information in your terminal with the following command.

# Prints your jlog.txt content to the terminal 
jlog -l

jlog's People

Contributors

michelml avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.