Skip to content

INSTALL.md

Latest commit

 

History

History
53 lines (38 loc) · 1022 Bytes

INSTALL.md

File metadata and controls

53 lines (38 loc) · 1022 Bytes
Raw

Installation Guide

Homebrew Installation

Recommended: Install from Tap

brew tap KikuAI-Lab/docstripper
brew install docstripper

Alternative: Install from Local Formula

brew install --build-from-source docstripper.rb

After installation, use:

docstripper document.txt

Manual Installation

# Clone repository
git clone https://github.com/KikuAI-Lab/DocStripper.git
cd DocStripper

# Make executable (optional, for direct usage)
chmod +x tool.py

# Use directly
python tool.py document.txt

# Or create symlink
sudo ln -s $(pwd)/tool.py /usr/local/bin/docstripper

Requirements

  • Python 3.9 or higher
  • For PDF support (optional): pdftotext from poppler-utils
    • macOS: brew install poppler
    • Ubuntu/Debian: sudo apt-get install poppler-utils
    • Windows: Download from poppler-windows releases

Verification

Run the self-test script:

python scripts/self_test.py