Skip to content

INSTALL.md

Latest commit

 

History

History
137 lines (98 loc) · 2.31 KB

INSTALL.md

File metadata and controls

137 lines (98 loc) · 2.31 KB

Installation Guide for Claude Log Viewer

Prerequisites

  • Python 3.8 or higher
  • pipx (recommended) or pip

Installing pipx (if not already installed)

brew install pipx
pipx ensurepath

Installation Methods

Method 1: Using pipx (Recommended)

pipx installs the application in its own isolated virtual environment and makes it globally available:

cd /path/to/logviewer
pipx install .

For development (editable install):

pipx install -e .

Method 2: Using pip with virtual environment

# Create a virtual environment
python3 -m venv ~/.venvs/claude-log-viewer
source ~/.venvs/claude-log-viewer/bin/activate

# Install the package
pip install /path/to/logviewer

# To make it globally accessible, create a symlink
ln -s ~/.venvs/claude-log-viewer/bin/claude-log-viewer /usr/local/bin/claude-log-viewer

Method 3: Direct pip install (system-wide)

pip3 install --user /path/to/logviewer

Running the Application

Once installed, you can run the log viewer from anywhere:

claude-log-viewer

The web interface will be available at: http://localhost:5001

Updating

With pipx:

pipx upgrade claude-log-viewer

Or if installed from local directory:

cd /path/to/logviewer
pipx reinstall .

With pip:

pip install --upgrade /path/to/logviewer

Uninstalling

With pipx:

pipx uninstall claude-log-viewer

With pip:

pip uninstall claude-log-viewer

Publishing to PyPI (Optional)

If you want to publish this package to PyPI so anyone can install it with pipx install claude-log-viewer:

  1. Install build tools:

    pip install build twine

  2. Build the package:

    cd /path/to/logviewer
python -m build

  3. Upload to PyPI:

    twine upload dist/*

Troubleshooting

Command not found after installation

Make sure the pipx bin directory is in your PATH:

pipx ensurepath

Then restart your terminal or run:

source ~/.zshrc  # or ~/.bashrc

Import errors

If you get import errors, make sure all dependencies are installed:

pip install -r requirements.txt

Permission errors

If you get permission errors with pip, use --user flag:

pip install --user /path/to/logviewer