- Notifications
You must be signed in to change notification settings - Fork5
pimalaya/comodoro
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
CLI to manage timers, based ontime-lib
- Centralized server timer controllable by multiple clients at the same time
- Multi protocols (onlyTCP for now, but you can build your own)
- Cycles customizable via config file (Pomodoro style,52/17 style, custom)
- Server and timer hooks customizable via config file (send system notification or run shell command)
Comodoro CLI is written inRust, and relies oncargo features to enable or disable functionalities. Default features can be found in thefeatures section of theCargo.toml.
Thev1.0.0 is currently being tested on themaster branch, and is the prefered version to use. Previous versions (including GitHub beta releases and repositories published versions) are not recommended.
Comodoro CLIv1.0.0 can be installed with a pre-built binary. Find the latestpre-releases GitHub workflow and look for theArtifacts section. You should find a pre-built binary matching your OS.
Comodoro CLIv1.0.0 can also be installed withcargo:
$ cargo install --frozen --force --git https://github.com/pimalaya/comodoro.git
These installation methods should not be used until thev1.0.0 is finally released, as they are all (temporarily) outdated:
Pre-built binary
Comodoro CLI can be installed with a prebuilt binary:
# As root:$ curl -sSL https://raw.githubusercontent.com/pimalaya/comodoro/master/install.sh| sudo sh# As a regular user:$ curl -sSL https://raw.githubusercontent.com/pimalaya/comodoro/master/install.sh| PREFIX=~/.local sh
These commands install the latest binary from the GitHubreleases section.
Binaries are built withdefault cargo features. If you want to enable or disable a feature, please use another installation method.
Cargo
Comodoro CLI can be installed withcargo:
$ cargo install comodoro# With only IMAP support:$ cargo install comodoro --no-default-features --features imapYou can also use the git repository for a more up-to-date (but less stable) version:
$ cargo install --git https://github.com/pimalaya/comodoro.git comodoro
Nix
Comodoro CLI can be installed withNix:
$ nix-env -i comodoro
You can also use the git repository for a more up-to-date (but less stable) version:
$ nix-env -if https://github.com/pimalaya/comodoro/archive/master.tar.gz# or, from within the source tree checkout$ nix-env -if.
If you have theFlakes feature enabled:
$ nix profile install comodoro# or, from within the source tree checkout$ nix profile install# you can also run Comodoro directly without installing it:$ nix run comodoro
Sources
Comodoro CLI can be installed from sources.
First you need to install the Rust development environment (see therust installation documentation):
$ curl https://sh.rustup.rs -sSf| shThen, you need to clone the repository and install dependencies:
$ git clone https://github.com/pimalaya/comodoro.git$cd comodoro$ cargo checkNow, you can build Comodoro:
$ cargo build --release
Binaries are available under thetarget/release folder.
The wizard is not yet available (it should come soon), so the only way to configure Comodoro CLI is to copy thesample config file then edit it by commenting or uncommenting the options you want.
How to debug Comodoro CLI?
The simplest way is to use--debug and--trace arguments.
The advanced way is based on environment variables:
RUST_LOG=<level>: determines the log level filter, can be one ofoff,error,warn,info,debugandtrace.RUST_SPANTRACE=1: enables the spantrace (a span represent periods of time in which a program was executing in a particular context).RUST_BACKTRACE=1: enables the error backtrace.RUST_BACKTRACE=full: enables the full error backtrace, which include source lines where the error originated from.
Logs are written to thestderr, which means that you can redirect them easily to a file:
RUST_LOG=debug comodoro 2>/tmp/comodoro.log
Special thanks to theNLnet foundation and theEuropean Commission that helped the project to receive financial support from various programs:
- NGI Assure in 2022
- NGI Zero Entrust in 2023
- NGI Zero Core in 2024(still ongoing)
If you appreciate the project, feel free to donate using one of the following providers:
About
CLI to manage timers
