https://github.com/qba73/habit
Habit tracker is a CLI app for tracking daily habits.
https://github.com/qba73/habit
go golang-cli
Last synced: 2 months ago
JSON representation
Habit tracker is a CLI app for tracking daily habits.
- Host: GitHub
- URL: https://github.com/qba73/habit
- Owner: qba73
- License: mit
- Created: 2022-07-08T13:11:33.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-11-23T20:31:02.000Z (over 1 year ago)
- Last Synced: 2025-03-25T11:49:16.700Z (3 months ago)
- Topics: go, golang-cli
- Language: Go
- Homepage:
- Size: 124 KB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Habit tracker
[](https://pkg.go.dev/github.com/qba73/habit)
[](https://goreportcard.com/report/github.com/qba73/habit)
[]()
This is a Go program that helps with establishing new, and tracking existing habits.
## Description
When we're trying to establish a new habit (studying, running, rowing for example), it can be difficult to maintain focus and motivation. Studies suggest that it takes many weeks of regularly performing a new habit before it becomes natural and automatic. So, if you can motivate yourself to do the new habit every day for a month or two, that'll get you well on the way.
One thing that can help is to _track_ your performance of the habit. Suppose you decide that you're going to spend at least 15 minutes every day studying or writing Go programs or going for a morning jog. You could draw 30 boxes on a piece of paper, one for each of the next 30 days, and check off each box as you do that day's practice.
This simple idea can be surprisingly effective, because we don't like to break a _streak_. If you've successfully done the habit every day for 29 days, there's a strong incentive not to break that run of success. Life has a way of coming at you, and you might well need that extra motivation at some point. Not today, not tomorrow, but soon: probably just around the time the novelty wears off.
The project is a Go package and accompanying command-line tool called ```habit``` that will help users track and establish new habits, by reporting their current streak.
## Using habit
For example, if you decide you want to build the habit of jogging every day, you might tell the habit tool about it like this:
**`habit jog`**
```
Good luck with your new habit 'jog'! Don't forget to do it again
tomorrow.
```
If you want to track multiple daily habits you tell the habit tool to track your new activity, for example:
**`habit study`**
```
Good luck with your new habit 'study'! Don't forget to do it again
tomorrow.
```
As the days go by, you might record each daily practice like this:
**`habit jog`**
```
Nice work: you've done the habit 'jog' for 18 days in a row now.
Keep it up!
```
If you happen to miss a couple of days, that's all right:
**`habit jog`**
```
You last did the habit 'jog' 3 days ago, so you're starting a new
streak today. Good luck!
```
If you just want to check how you're doing, you could run:
**`habit`**
```
You're currently on a 1-day streak for 'jog'. Stick to it!
You're currently on a 1-day streak for 'study'. Stick to it!
```
or, if you keep streeks not broken:
```
You're currently on a 4-day streak for 'jog'. Stick to it!
You're currently on a 17-day streak for 'study'. Stick to it!
```
Maybe the news won't be quite so good:
```
You're currently on a 1-day streak for 'hike'. Stick to it!
It's been 10 days since you did 'jog'. It's ok, life happens. Get back on that horse today!
It's been 17 days since you did 'study'. It's ok, life happens. Get back on that horse today!
```
# Installation
## Storing data
`habit` persists data in a file storage. If you want to configure `habit` where to locate the file store, export the ENV variable `$XDG_DATA_HOME`. If the env var is not exported `habit` will create file store in user's `$HOME` directory.
## Using `brew`
```bash
brew tap qba73/tap
```
```bash
brew install habit
```
## Using `go install`
```bash
go install github.com/qba73/habit/cmd@latest
```
Verify installation:
```bash
habit
You are not tracking any habit yet.
```
Start tracking a habit:
```bash
habit jog
Good luck with your new habit 'jog'. Don't forget to do it tomorrow.
```
Check tracked habits:
```bash
habit
You're currently on a 1-day streak for 'jog'. Stick to it!
```
## Building from source
Clone this repository to your local machine:
```bash
git clone [email protected]:qba73/habit.git
cd habit
```
Build `habit` binary:
```bash
go build -o habit ./cmd/main.go
```
Run `habit`:
```bash
./habit
```
## Development
Use following make targets for developemnt and testing:
```bash
$ make
Usage:
help Show help message
dox Run tests with gotestdox
test Run tests
vet Run go vet
check Run staticcheck analyzer
cover Run unit tests and generate test coverage report
tidy Run go mod tidy
```
## Credits
This is an educational Go project intended for students at the [Bitfield Institute of Technology](https://bitfieldconsulting.com/golang/bit).