🛡️ reddacted

✨ Key Features

🔐 Can I trust this with my data?

reddacted user yourusername --local-llm "http://localhost:11434"

• ✅ Client-side execution only, no tracking or external calls
• ✅ Session-based authentication if you choose - it is optional unless you want to delete
• ✅ Keep your nonsense comments with lots of upvotes and good vibes without unintentionally doxing yourself

reddacted user taylorwilsdon --limit 3

📋 Table of Contents

• Key Features
• Can I trust this with my data?
• Installation
• Usage
  • Available Commands
  • Common Arguments
  • LLM Configuration
• How accurate is the PII detection?
• FAQ
• Troubleshooting
• Authentication
• Advanced Usage
• Development
• Testing
• Common Exceptions
• Support & Community

📥 Installation

# Install from brew (recommended)
brew install taylorwilsdon/tap/reddacted

# Install from PyPI (recommended)
pip install reddacted

# Or install from source
git clone https://github.com/taylorwilsdon/reddacted.git
cd reddacted
pip install -e ".[dev]"  # Installs with development dependencies

🚀 Usage

# Most basic possible quick start - this will walk you through selecting your LLM in the command line
reddacted user spez

# Analyze a user's recent comments with local LLM specified
reddacted user spez \
  --limit 5 \
  --local-llm "http://localhost:11434" \
  --model "qwen2.5:3b" \
  --sort new

# Analyze controversial comments with OpenAI
export OPENAI_API_KEY="your-api-key"
reddacted user spez \
  --sort controversial \
  --time month \
  --model "gpt-4" \
  --limit 10 \
  --pii-only

# Analyze a specific subreddit post with PII filter disabled
reddacted listing r/privacy abc123 \
  --local-llm "http://localhost:11434" \
  --model "qwen2.5:3b" \
  --disable-pii \
  --sort new

# Search for specific content (requires auth)
reddacted user spez \
  --enable-auth \
  --text-match "python" \
  --skip-text "deleted" \
  --sort top \
  --time all

# Bulk comment management
reddacted delete abc123,def456 --batch-size 5  # Delete comments
reddacted update abc123,def456                 # Replace with standard redaction message
reddacted update abc123,def456 --use-random-string  # Replace with random UUID

Available Commands

Common Arguments

LLM Configuration

export OPENAI_API_KEY="your-api-key"

❓ How accurate is the PII detection, really?

Surprisingly good. Good enough that I run it against my own stuff in delete mode. It's basically a defense-in-depth approach combining these methods:

💡 FAQ

🔧 Troubleshooting

If you get "command not found" after installation:

1. Check Python scripts directory is in your PATH:

# Typical Linux/Mac location
export PATH="$HOME/.local/bin:$PATH"

# Typical Windows location
set PATH=%APPDATA%\Python\Python311\Scripts;%PATH%

2. Verify installation location:

pip show reddacted

🔑 Authentication

Before running any commands that require authentication, you'll need to set up your Reddit API credentials:

export REDDIT_USERNAME=your-reddit-username
export REDDIT_PASSWORD=your-reddit-password
export REDDIT_CLIENT_ID=your-client-id
export REDDIT_CLIENT_SECRET=your-client-secret

These credentials are also automatically used if all environment variables are present, even without the --enable-auth flag.

🧙‍♂️ Advanced Usage

Text Filtering

You can filter comments using these arguments:

For example:

# Only analyze comments containing "python"
reddacted user spez --text-match "python"

# Skip comments containing "deleted"
reddacted user spez --skip-text "deleted"

# Combine both filters
reddacted user spez --text-match "python" --skip-text "deleted"

👨‍💻 Development

This project uses UV for building and publishing. Here's how to set up your development environment:

1. Create and activate a virtual environment:

python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

2. Install UV:

pip install uv

3. Install in development mode with test dependencies:

pip install -e ".[dev]"

4. Build the package:

uv build --sdist --wheel

5. Create a new release:

./release.sh

The release script will:

• Build the package with UV
• Create and push a git tag
• Create a GitHub release
• Update the Homebrew formula
• Publish to PyPI (optional)

That's it! The package handles all other dependencies automatically, including NLTK data.

🧪 Testing

Run the test suite:

pytest tests

Want to contribute? Great! Feel free to:

• Open an Issue
• Submit a Pull Request

⚠️ Common Exceptions

Pro Tip: Always review changes before executing deletions!

🌐 Support & Community