Skip to content

Installation

tomodo can be installed using the following methods:

Install with Homebrew

You can install tomodo with Homebrew by running the following commands:

brew tap yuvalherziger/homebrew-tomodo
brew install tomodo

After installing the tool with brew, you can run it the following way:

tomodo --help

Upgrade Homebrew Package

To upgrade the tomodo Homebrew package to the latest version, use the following commands:

brew update
brew upgrade tomodo

Install with pip

To install the tool with pip, run the following command:

pip install tomodo

Install from Source

If you wish to set up a development environment, you can install tomodo using Python. The recommended way to perform the Python installation is by using the Poetry Python package manager.

Requirements:

Install with Poetry Package Manager for Python

If you have the Poetry Python package manager installed locally, you can install the CLI the following way:

git clone https://github.com/yuvalherziger/tomodo.git
cd tomodo
poetry shell
poetry install

After installing the tool with Poetry, you can run it the following way:

tomodo --help

Install from source with pip

You can install the dependencies with pip using the following command:

git clone https://github.com/yuvalherziger/tomodo.git
cd tomodo
pip install .

After installing the dependencies with pip, you can validate the installation by invoking the help page:

python tomodo/cmd.py --help