https://github.com/rogeruiz/srht-tick
This repository has been moved to sourcehut under the same username and repository name. Tick is a CLI time-tracking tool written in Rust. ⏱
https://github.com/rogeruiz/srht-tick
cli emotional-hygiene journal rust time-keeping
Last synced: 3 months ago
JSON representation
This repository has been moved to sourcehut under the same username and repository name. Tick is a CLI time-tracking tool written in Rust. ⏱
- Host: GitHub
- URL: https://github.com/rogeruiz/srht-tick
- Owner: rogeruiz
- License: mit
- Created: 2016-06-11T21:48:37.000Z (over 9 years ago)
- Default Branch: main
- Last Pushed: 2021-06-04T21:15:20.000Z (over 4 years ago)
- Last Synced: 2024-04-14T15:50:31.364Z (over 1 year ago)
- Topics: cli, emotional-hygiene, journal, rust, time-keeping
- Language: Rust
- Homepage:
- Size: 115 KB
- Stars: 15
- Watchers: 2
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Tick CLI for tracking your time
I use `tick` to track all my time using `tmux` sessions. But `tick` can be used
without `tmux`, `node` or any other dependency. The `tick` CLI is written in Rust.
Info | Description
--- | ---
[](https://travis-ci.org/rogeruiz/tick) | Project build status for Tick CLI
[Installation](#installation) | Installing Tick CLI.
[Motivation](#motivation) | Why use Tick CLI?
[Commands](#commands) | Using Tick CLI.
[Inspiration](#inspiration) | Everything is a remix, including Tick CLI.
[Contributing](CONTRIBUTING.md) | Contribute to Tick CLI.
[License](LICENSE.md) | License for Tick CLI.
## Installation
To install Tick, you can either compile it from source or download the binary
from [the releases page][tick-releases] for the release you want and the
platform you need.
[tick-releases]: https://github.com/rogeruiz/tick/releases "The releases for this repo"
### Supported platforms
Tick has been used daily by me on different platforms such as macOS, Ubuntu, and
Arch. While it hasn't been tested on other platforms such as Windows, patches
are welcome to add tests for this.
### Dependencies
Tick leverages SQlite 3+ as a database. Make sure you have `sqlite3` installed
on your machine. This ships with macOS and can usually be installed with a
package manager on your platform of choice.
### Compiling Tick from source
The steps are pretty straight-forward as long as you are within the realm of
[Tier 1 support][rustlang-tier1] for the Rust compiler.
[rustlang-tier1]: https://forge.rust-lang.org/platform-support.html#tier-1 "Rust Platform Support"
```shell
# Clone the repository.
>_ git clone https://github.com/rogeruiz/tick.git
>_ cd tick
# Setup your Tock configuration file
>_ mkdir -p ~/.config/tick
>_ echo "database_path: ~/.config/tick/main.db" > "${_}/config.yaml"
# Build the release.
>_ cargo build --release
# Install in your path.
>_ cp ./target/release/tick /usr/local/bin/tick
```
## Motivation
I track my time a lot while using the terminal using a wrapper around `tmux`.
The wrapper I have is [a shell script called `tux`][tux-src]. While the wrapper
works great, it depends on `clocker` and `node` to handle time tracking.
The main motivation around writing this was to remove the `node` and `clocker`
dependencies from `tux` along with adding customizable exporting mechanisms.
Tracking your time can be hard enough, so Tick tries making it a lot easier.
[tux-src]: https://github.com/rogeruiz/.files/blob/master/bin/tux "`.files/bin/tux` Source"
## Commands
Run `tick --help` to see all the available commands you can use. Below is an
example workflow of how you would use Tick.
```sh
>_ tick [ -v ] start --name my-timer [ --message "I can do the thing!" ]
>_ tick [ -v ] status
>_ tick [ -v ] stop --name my-timer [ --message "I did the thing!" ]
>_ tick [ -v ] stop [ --message "I did the thing!" ] # without a name argument stops the latest running timer
>_ tick [ -v ] list
>_ tick [ -v ] remove --id $( tick list | tail -1 | awk '{ print $1 }' ) # delete the latest timer by Timer ID
```
## Inspiration
This project would not be possible without being inspired by other's work.
- `clocker` - [repository][clocker-repo]
- `watson` - [repository][watson-repo]
[clocker-repo]: https://github.com/substack/clocker "Clocker Repository"
[watson-repo]: https://github.com/TailorDev/Watson "Watson Repository"