Installation

Installation

Building from Source

Prerequisites

• Rust: Version 1.87 or later
• Cargo: Comes with Rust installation
• Git: For cloning the repository

Build Steps

# Clone the repository
git clone <repository-url>
cd taskflow

# Build release version (optimized)
cargo build --release

# The binary is located at:
./target/release/taskflow

Install to PATH

# Option 1: Copy to local bin (user only)
cp ./target/release/taskflow ~/.local/bin/

# Option 2: System-wide installation (requires sudo)
sudo cp ./target/release/taskflow /usr/local/bin/

Verify Installation

taskflow --version

---

Shell Completions

TaskFlow supports tab completion for Bash, Zsh, and Fish.

Bash

# Generate and install
taskflow completion bash > ~/.local/share/bash-completion/completions/taskflow

# Or system-wide (requires sudo)
sudo taskflow completion bash > /etc/bash_completion.d/taskflow

# Reload completions
source ~/.local/share/bash-completion/completions/taskflow

Zsh

# Create completions directory
mkdir -p ~/.zsh/completions

# Generate completions
taskflow completion zsh > ~/.zsh/completions/_taskflow

# Add to ~/.zshrc (if not already present):
# fpath=(~/.zsh/completions $fpath)
# autoload -Uz compinit && compinit

# Reload
source ~/.zshrc

Fish

# Generate and install (Fish loads automatically)
taskflow completion fish > ~/.config/fish/completions/taskflow.fish

---

First Run

# Run with default settings
taskflow

# Run with demo data to explore features
taskflow --demo

On first launch, TaskFlow creates:

• Data file: ~/.local/share/taskflow/tasks.json (Linux)
• Config directory: ~/.config/taskflow/ (Linux)

See Configuration for customization options.

---

Platform Notes

Linux

Default paths:

• Data: ~/.local/share/taskflow/
• Config: ~/.config/taskflow/

macOS

Default paths:

• Data: ~/Library/Application Support/taskflow/
• Config: ~/.config/taskflow/

Windows

Default paths:

• Data: %APPDATA%\taskflow\
• Config: %APPDATA%\taskflow\config\

---

Next Steps

• Quick-Start - Learn the basics in 5 minutes
• Interface - Understand the UI layout
• Configuration - Customize TaskFlow