# Run with local LLM - you'll be guided through configuration
reddacted user yourusername

• ✅ 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
• ✅ All configuration stored locally in config.json

# Quick analysis with custom limit
reddacted user taylorwilsdon --limit 3

• 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

# 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

reddacted now features a guided configuration flow that makes setup easy. Simply run any command and you'll be prompted to configure your settings through an interactive interface:

# Most basic possible quick start - launches the guided configuration flow
reddacted user spez

# The guided flow will prompt you to:
# - Choose between OpenAI or local LLM
# - Enter your API key or local LLM URL
# - Select your model from available options
# - Configure authentication settings
# - Set analysis preferences (limit, sort, time filter, etc.)
# - Save your configuration for future use

The interactive configuration flow includes:

• LLM Settings: Choose between OpenAI API or local LLM endpoint (like Ollama)
• Authentication: Enable Reddit API authentication if needed
• Analysis Options: Set comment limits, sort order, time filters
• Output Options: Configure file output, PII filtering preferences
• Advanced Settings: Text matching patterns, batch sizes for bulk operations

Your configuration is automatically saved to config.json for reuse.

Once configured, you can run commands like:

# Analyze a user's recent comments (uses saved config)
reddacted user spez

# Analyze a specific subreddit post
reddacted listing r/privacy abc123

# Bulk comment management
reddacted delete abc123,def456  # Delete comments
reddacted update abc123,def456  # Replace with standard redaction message

You can still override saved settings with command-line arguments:

# Override the saved limit
reddacted user spez --limit 50

# Use a different model temporarily
reddacted user spez --model "gpt-4-turbo"

# Enable authentication for this run only
reddacted user spez --enable-auth

The guided configuration flow will help you set up your LLM preferences. You can choose between:

1. Local LLM (Ollama, vLLM, etc.):

   • Default endpoint: http://localhost:11434
   • Automatically fetches available models
   • No API key required

2. OpenAI API:

   • Enter your OpenAI API key
   • Select from available OpenAI models
   • Supports custom API base URLs

Configuration values are saved to config.json and can be overridden with command-line flags:

export OPENAI_API_KEY="your-api-key"
export REDDIT_USERNAME="your-username"
export REDDIT_PASSWORD="your-password"
export REDDIT_CLIENT_ID="your-client-id"
export REDDIT_CLIENT_SECRET="your-client-secret"

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:

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

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.

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"

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.

Run the test suite:

pytest tests

Want to contribute? Great! Feel free to:

• Open an Issue
• Submit a Pull Request

Pro Tip: Always review changes before executing deletions!