Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/j4ng5y/comp-time-tracker

a little time tracker for my personal comp time
https://github.com/j4ng5y/comp-time-tracker

go golang time-tracker

Last synced: 14 days ago
JSON representation

a little time tracker for my personal comp time

Host: GitHub
URL: https://github.com/j4ng5y/comp-time-tracker
Owner: j4ng5y
Created: 2019-06-29T14:59:16.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2019-07-02T16:54:48.000Z (over 5 years ago)
Last Synced: 2023-03-21T20:33:42.567Z (almost 2 years ago)
Topics: go, golang, time-tracker
Language: Go
Size: 2.15 MB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# Comp Time Tracker

This is a small little app that just helps me track my comp time while working on contracts.

## Installation

### Linux

`sudo curl -o /usr/local/bin/ctt https://github.com/j4ng5y/comp-time-tracker/releases/download/2019.07.02/ctt-2019.07.02-linux-amd64`

### OSX

`sudo curl -o /usr/local/bin/ctt https://github.com/j4ng5y/comp-time-tracker/releases/download/2019.07.02/ctt-2019.07.02-darwin-amd64`

### Windows

See building from source

## Building From Source

1. Have Go installed (you can get it [here](https://golang.org/dl/))
2. Clone This Repository (`git clone https://github.com/j4ng5y/comp-time-tracker $GOROOT/src/github.com/j4ng5y/comp-time-tracker`)
3. Navigate into the repository (`cd $GOROOT/src/github.com/j4ng5y/comp-time-tracker`)
4. Build the tool (`CGO_ENABLE=1 go build -a -installsuffix cgo -o bin/ctt`)
5. Install the tool:
* `ln -s $GOROOT/src/github.com/j4ng5y/comp-time-tracker/bin/ctt /usr/local/bin/ctt`
or
* `go install`

## Usage

```text
A small app to track comp time

Usage:
cct [flags]
cct [command]

Available Commands:
delete delete a comp time entry
help Help about any command
new create a new comp time entry
view view comp time entries

Flags:
-h, --help help for cct
--version version for cct

Use "cct [command] --help" for more information about a command.
```

## Examples

### Adding a new time entry

#### new Usage

```text
create a new comp time entry

Usage:
cct new [flags]

Flags:
-d, --day int the day of the entry
-h, --help help for new
-m, --month int the month of the entry
-n, --note string a note for the entry
-T, --time int the amount of time to add (positive integer) or subtract (negative integer) from the running total
-t, --title string the title of the entry to create
-y, --year int the year of the entry
```

#### new Commands Examples

`ctt new -t "" -T -m -d -y -n ""`

To add a new 30 minute entry on July 1, 2019, it would like this:

`ctt new -t "This is a test entry" -T 30 -m 07 -d 01 -y 2019 -n "This test entry is used just to test the functionality of the ctt tool."`

You will see something to the effect of this:

`2019/07/02 11:26:01 Entry {955c8c75-0d7d-48f2-a534-866abcdd1f31 7 1 2019 This is a test entry 30 This test entry is used just to test the functionality of the ctt tool.} added`

### Viewing entries

#### view Usage

```text
view comp time entries

Usage:
cct view [flags]

Flags:
-h, --help help for view
-s, --single-entry string view a single entry
-D, --total-days use this flag to view running time in days
-H, --total-hours use this flag to view running time in hours
-M, --total-minutes use this flag to view running time in minutes
-t, --total-only use this flag if you only want to output the running total
```

#### view Command Examples

*View All Entries*
`ctt view`

This will output something like this (expanding on the previous example):

*View One Entry*
`ctt view -s ""`

This will output something like this (expanding on the previous example):

```text
ID: 955c8c75-0d7d-48f2-a534-866abcdd1f31
Date: 7-1-2019
Title: This is a test entry
Time: 30
Note: This test entry is used just to test the functionality of the ctt tool.
```

*View Totals Only*
**View In Minutes**: `ctt view -t -M`

Which outputs something like this (expanding on the previous example):

```text
2019/07/02 11:35:30 The current running total of all comp time is: 30 minutes
```

**View In Hours**: `ctt view -t -H`

Which outputs something like this (expanding on the previous example):

```text
2019/07/02 11:35:30 The current running total of all comp time is: 0 hours
```

**View In Days**: `ctt view -t -D`

Which outputs something like this (expanding on the previous example):

```text
2019/07/02 11:36:21 The current running total of all comp time is: 0 days
```

### Delete Entries

#### delete Usage

```text
delete a comp time entry

Usage:
cct delete [flags]

Flags:
-h, --help help for delete
-i, --id string the ID of the entry to delete
```

#### delete Command Examples

`ctt delete -i ""`

Which outputs something like this (expanding on the previous example):

```text
2019/07/02 11:39:01 Successfully removed entry with ID: 955c8c75-0d7d-48f2-a534-866abcdd1f31
```