Research-Stack/5-Applications/nodupe/wiki/Getting-Started.md

Getting Started

Installation

# Clone the repository
git clone https://github.com/allaunthefox/NoDupeLabs.git
cd NoDupeLabs

# Create virtual environment
python -m venv .venv
source .venv/bin/activate  # Linux/macOS
# .venv\Scripts\activate  # Windows

# Install dependencies
pip install -e .

Basic Usage

Scan for Duplicates

nodupe scan /path/to/directory

Apply Changes

nodupe apply --plan plan.json

Check Similarity

nodupe similarity --file document.txt

Configuration

Create nodupe.toml in your project root:

[database]
path = ".nodupe/database.db"

[scanning]
threads = 4
hash_size = 8192

Running Tests

pytest tests/ -v

Project Structure

nodupe/
├── core/           # Core system modules
├── plugins/        # Plugin implementations
└── ...

Next Steps

• Read the Architecture Overview
• Learn about Plugin Development
• Check the CLI Reference