logit

command module

v1.0.0 Latest Latest Go to latest Published: Apr 14, 2025 License: MIT Imports: 7 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/FilipFl/logit

Links

Open Source Insights

README ¶

logit

A simple CLI tool to log work time into Jira straight from your terminal. Allows to seemlesly log time into tasks You're working on without interrupting Your workflow.

safe - allows You to set environmental variable name instead of storing Your jira Personal Access Token in plain text
integrated with Git - if Your current branch contains task key You don't need to pass task explicitly
capable of measuring time - just use logit start when starting Your workday, each subsequent log will restart the time allowing precise measurement
allows to set aliases for the tasks You frequently log time on (and autocomplete them for You if You wish!)
provides one command to fetch all tasks You're assigned to

logit is compatible with jira onprem (won't work for jira cloud) and tested with jira software 9.12

Installation

go build -o bin/logit // build binary
sudo cp bin/logit /usr/local/bin/logit // copy it to bin directory 
logit config init // let logit prompt You for needed settings

Or using Make:

make install
// and follow with
logit config init

if You wish to allow alias auto completion run:

sudo make allow-autocompletion

Usage

logit [command] [flags]

Example

logit alias set daily JIRA-111

logit log --task JIRA-123 -H 2 --comment "Worked on backend bug" // will log 2 hours for task JIRA-123 for today

logit log --task https://your-jira-host.com/issue/JIRA-111 -m 30 -c "Worked on frontend bug" // will log 30 minutes for task JIRA-111 for today

logit log -a daily -m 20  // will log 20 minutes for task aliased by "daily"

logit log -H 5 -y // will log 5 hours, for the task mentioned in current git branch, for the yesterday

logit log --task JIRA-321 -f // will attempt to log time passed from latest snapshot for today

Available Commands

Root Level

Command	Description
log	Log time to a Jira task
config	Set of configuration commands
alias	Set of alias commands
start	Start time measure in this moment
tasks	List tasks assigned to You
help	Show help for any command

Config Level

Command	Description
config init	Set needed configs
config set-origin [origin]	Set Jira origin (schema + host)
config set-token [token]	Set personal Jira token
config set-token-env-name [name]	Set name of environmental variable where logit can find jira token
config trustGitBranch	Change value of trust git branch variable (if `true` logit will not prompt for approve of task key extracted from git branch)
config help	Show help for any command

Alias Level

Command	Description
alias set [alias] [task]	Save new task alias
alias remove [alias]	Remove saved alias
alias list	List saved aliasses
alias help	Show help for any command

Log Flags

Flag	Flag shorthand	Description	Example
--task	-t	Jira task key / task url (if ommitted with `alias` flag git branch is inspected)	--task JIRA-123
--alias	-a	Jira task key alias (if ommitted with `task` flag git branch is inspected)	--alias myTask
--hours	-H	Duration to log in hours (e.g. 1h) (if both `hours` and `minutes` flags are ommited time snapshot is used)	--hours 1
--minutes	-m	Duration to log in minutes (e.g. 30m) (if both `hours` and `minutes` flags are ommited time snapshot is used)	--minutes 30
--comment	-c	Worklog comment	--comment "Fixed login bug"
--yesterday	-y	Log work for yesterday	--yesterday
--date	-d	Log work for date (dd.mm or dd-mm format required), current year is assumed	--date 12.03
--reset	-r	If used with `hours` or `minutes` flags forces to reset snapshot on time log	--reset
--force	-f	Forces all boolean prompts to pass	-f