Skip to content

zero-point-one-x-engineer/yatter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Yatter

license-mit license-apache Rust

Yet another Time Tracker is a CLI punch in & out time tracker.

Another one? Aren't there like a bunch of better options out there?

Certainly! I just needed an excuse to start learning Rust. 😄

Installation

There isn't a released version of yatter yet and so if you want to install it you'd have to build the binaries yourself. To do that you'd need to have Rust installed.

After that you can clone this repo:

git clone https://github.com/AntonisManiatis/yatter.git

cd into your cloned repo and do:

cargo build --release

After cargo is finished you'll find the compiled binary for your OS & architecture in ./target/release.

Finally set a Path environment variable pointing to the binary so you can use yatter from your shell.

Starship

If you have starship you can add this to your starship.toml.

[custom.yatter]
command = "yatter status"
when = "yatter status"
symbol = "" # test one, I don't want to get sued.
format = " [$symbol($output)]($style) "
style = "bold yellow"

Here's how that would look like:

Usage

Let's assume you have your work projects structured like this:

.
├── ...
├── work
│   ├── project_x
│   │   ├── ...
│   │   ├── docs            # project related docs
│   │   ├── be_repo         # back-end git repo
│   │   └── fe_repo         # front-end git repo
│   ├── project_y
│   │   └── ...
│   └── project_z
│       └── ...
└── ...

And you have a task that you'd like to track your time for project_x.

Open up a terminal and type:

yatter init ./work/project_x

To punch in for that project:

yatter punch ./work/project_x

After you are done with your task you again use punch to punch out:

yatter punch ./work/project_x -d "Added search functionality to navbar."

To check if you have punched in or out for a project:

yatter status ./work/project_x

For additional info please use:

yatter --help

Contributing

If you have any ideas or features to suggest, or found any bugs.

See CONTRIBUTING.md for details.

License

Yatter is distributed under the terms of both the MIT license and the Apache License (Version 2.0).

See LICENSE_APACHE and LICENSE_MIT for details.

About

Yet another Time Tracker, A CLI tool to track time for developers.

Topics

Resources

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE_APACHE
MIT
LICENSE_MIT

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages