Installation¶

TaskRepo supports multiple installation methods. Choose the one that best fits your workflow.

macOS (Homebrew) - Recommended for Mac Users¶

The easiest way to install TaskRepo on macOS:

# Tap the HenriquesLab formulas repository
brew tap henriqueslab/formulas

# Install TaskRepo
brew install taskrepo

Updating:

brew update
brew upgrade taskrepo

Benefits: - Simple installation process - Automatic dependency management (Python 3.12, git, gh) - Easy updates with standard Homebrew commands

pipx (Recommended for Linux/Windows)¶

pipx installs CLI tools in isolated environments:

# Install pipx if you haven't already
python3 -m pip install --user pipx
python3 -m pipx ensurepath

# Install TaskRepo
pipx install taskrepo

Updating:

pipx upgrade taskrepo

Benefits: - Isolated environment prevents conflicts - Global CLI access from any directory - Easy updates - Clean uninstallation

uv (Fast Alternative)¶

uv is a fast Python package installer and manager:

# Install uv if you haven't already
curl -LsSf https://astral.sh/uv/install.sh | sh

# Install TaskRepo
uv tool install taskrepo

Updating:

uv tool upgrade taskrepo

Benefits: - Very fast installation (faster than pip/pipx) - Modern Python tooling - Automatic environment management - Compatible with Python 3.10+

pip (Alternative)¶

Standard Python package installation:

pip install taskrepo

Verifying Installation¶

After installation, verify TaskRepo is working:

# Check version
tsk --version

# Or using full command name
taskrepo --version

You should see output like:

TaskRepo v0.9.9

Requirements¶

• Python 3.10 or higher
• git (for repository management)
• gh (optional, for GitHub integration)

Next Steps¶

Now that TaskRepo is installed:

1. Initialize TaskRepo - Set up your configuration
2. Create your first task - Learn the basics
3. Explore commands - Command reference

Troubleshooting¶

Command not found¶

If you get "command not found" after installation:

pipx users:

# Ensure pipx bin directory is in PATH
python3 -m pipx ensurepath
# Then restart your terminal

uv users:

# Add uv tools to PATH (usually automatic)
source $HOME/.cargo/env

Permission denied¶

If you get permission errors:

# Don't use sudo with pip!
pip install --user taskrepo

# Or use pipx/uv which handle this automatically

Python version issues¶

Check your Python version:

python3 --version

TaskRepo requires Python 3.10+. If you have an older version, upgrade Python first.

For more help, see the Troubleshooting Guide.