Installation
Cargo
Comodoro can be installed with cargo:
$ cargo install comodoro
You can also use the git repository for a more up-to-date (but less stable) version:
$ cargo install --git https://github.com/soywod/comodoro comodoro
Comodoro comes with few features:
client
: enable thetimer
subcommand to manage timersserver
: enable theserver
subcommand to manage serverstcp-client
: enable the TCP clienttcp-binder
: enable the TCP binder for the serverhook-command
: enable hook based on shell commandshook-notify
: enable hooks based on system notifications
By choosing features you need, you can build a smaller executable. For example, if you only need the tcp-binder
with hook-notify
, you can run this command:
$ cargo install --no-default-features --features tcp-binder --features hook-notify comodoro
Nix
Comodoro can be installed with Nix:
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/soywod/comodoro/archive/master.tar.gz
# or, from within the source tree checkout
nix-env -if .
If you have the Flakes 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
Development environment
To enter a development shell:
nix-shell
# or, with the Flakes feature enabled
nix develop
From here, you have access to all the development tools (Rust compiler, cargo, rust language server, code formatter…) necessary to hack on Comodoro.
Binary
Comodoro can be installed with a prebuilt binary:
# As root:
curl -sSL https://pimalaya.org/comodoro/cli/install.sh | sudo sh
# As a regular user:
curl -sSL https://pimalaya.org/comodoro/cli/install.sh | PREFIX=~/.local sh
Those commands install the latest binary from the GitHub releases section.
Note: Linux, macOS and Windows are supported. Note that some features may not work as expected on Windows.
Sources
Comodoro can be installed from sources.
First you need to install the Rust development environment (see the rust installation documentation):
curl https://sh.rustup.rs -sSf | sh
Then, you need to clone the repository and install dependencies:
git clone https://github.com/soywod/comodoro.git
cd comodoro
cargo check
Now, you can build Comodoro:
cargo build --release
Note: binaries are available in the target/release
folder.