🛠️ ZelUtil

The foundation of the Zel productivity suite - handles installation, configuration, and shared utilities for all Zel tools.

---

🚀 Quick Start

Install ZelUtil and set up the Zel ecosystem with one command:

Linux/macOS:

curl -sSL https://raw.githubusercontent.com/Zeldean/zelutil/main/bootstrap-zel.py | python3

Windows PowerShell 5+:

irm https://raw.githubusercontent.com/Zeldean/zelutil/main/bootstrap-zel.py | python

That's it! This will:

• 📥 Download and set up ZelUtil
• 🐍 Create a dedicated Python environment for all Zel tools
• ⚡ Make the zelutil command available in your terminal

---

🎯 Custom Installation

Want to install somewhere specific? Download and run with --install-dir:

# Download and run with custom directory
curl -o bootstrap-zel.py https://raw.githubusercontent.com/Zeldean/zelutil/main/bootstrap-zel.py
python3 bootstrap-zel.py --install-dir ~/my-zel-tools

---

🔧 Development Setup

For local development and testing:

# Clone the repository
git clone https://github.com/Zeldean/zelutil.git
cd zelutil

# Run local development install
python3 dev-install.py

What this does:

• Creates ../temp_venv/ (isolated from main installation)
• Installs zelutil in editable mode for live development
• Provides direct path to test commands

Usage after dev install:

# Test your changes directly
../temp_venv/bin/zelutil --help

# Or activate the environment
source ../temp_venv/bin/activate
zelutil --help

Benefits:

• 🔄 Changes reflect immediately (no reinstall needed)
• 🔒 Isolated from your main zel installation
• 🧪 Perfect for testing new features
• 🚀 No need to push to GitHub for every test

---

📁 What Gets Installed Where

After installation, you'll have two main directories:

🏠 Installation Files

Location: ~/.local/share/zel/ (Linux/macOS) or %LOCALAPPDATA%\zel\ (Windows)

This contains:

• venv/ - The Python environment for all Zel tools
• zelutil/ - ZelUtil source code
• Future Zel tools will be installed here too

💾 Your Data

Location: ~/.local/state/zel/ (all platforms)

This is where your personal data lives:

• ⚙️ Settings and preferences
• ⏱️ Timer logs
• 📝 Journal entries
• 🔗 File paths and bookmarks

---

✅ Requirements

• 🐍 Python 3.8 or newer
• 📦 Git (for downloading tools)
• 🌐 Internet connection (for initial setup)

---

🗑️ Uninstalling

To remove everything:

1. Delete the installation directory: ~/.local/share/zel/
2. Remove from your shell config (look for "# Zel tools" in ~/.bashrc or ~/.zshrc)
3. Optionally delete your data: ~/.local/state/zel/