Skip to content

INSTALLATION.md

Latest commit

 

History

History
154 lines (101 loc) · 3.07 KB

INSTALLATION.md

File metadata and controls

154 lines (101 loc) · 3.07 KB

📦 TagManager Installation Guide

🚀 Quick Installation

Option 1: Install from PyPI (Recommended)

pip install tagmanager-cli

Option 2: Install from Source

# Clone the repository
git clone https://github.com/davidtbilisi/TagManager.git
cd TagManager

# Install directly
pip install .

# Or build and install
pip install build
python -m build
pip install dist/tagmanager_cli-1.0.0-py3-none-any.whl

Option 3: Development Installation

# Clone and install in development mode
git clone https://github.com/davidtbilisi/TagManager.git
cd TagManager
pip install -e .

📋 Requirements

  • Python 3.7+ (Python 3.8+ recommended)
  • UTF-8 compatible terminal (most modern terminals)

Dependencies

TagManager automatically installs these dependencies:

  • typer>=0.9.0 - Modern CLI framework
  • rich>=10.0.0 - Beautiful terminal output

🎯 Verify Installation

After installation, verify TagManager is working:

# Test the main command
tm --help

# Or use the full name
tagmanager --help

# Test basic functionality
tm stats

You should see the TagManager help menu with all available commands.

🔧 Command Aliases

TagManager provides two command aliases:

  • tm - Short and convenient for daily use
  • tagmanager - Full name for clarity

Both commands are identical in functionality.

🏠 Configuration

TagManager creates its configuration automatically on first run:

  • Config file: ~/.tagmanager/config.ini
  • Tag database: ~/.tagmanager/file_tags.json

🚀 Quick Start

# Add tags to a file
tm add document.pdf --tags work important project-x

# Search for files
tm search --tags work

# View all files in a tree
tm ls --tree

# Get statistics
tm stats --chart

# Bulk operations
tm bulk add "*.py" --tags python code

# Smart filtering
tm filter duplicates

🔄 Updating

To update TagManager to the latest version:

pip install --upgrade tagmanager-cli

🗑️ Uninstallation

To remove TagManager:

pip uninstall tagmanager-cli

Note: This will not remove your tag database or configuration files. To completely remove all data:

# Remove the package
pip uninstall tagmanager-cli

# Remove data (optional)
rm -rf ~/.tagmanager/  # Linux/macOS
rmdir /s %USERPROFILE%\.tagmanager  # Windows

🐛 Troubleshooting

Common Issues

  1. Command not found: Ensure Python's Scripts directory is in your PATH
  2. Permission errors: Use pip install --user tagmanager-cli for user installation
  3. Import errors: Ensure you have Python 3.7+ and all dependencies installed

Getting Help

If you encounter issues:

  1. Check the GitHub Issues
  2. Run tm --help for command documentation
  3. Create a new issue with your error details

🎉 Next Steps

After installation, check out:

Happy tagging! 🏷️