Installation

Requirements

• Python 3.10 or higher
• pip or uv package manager

Installation Methods

Using pip (Recommended)

pip install ripperdoc

Using uv

uvx tool install ripperdoc

From Source

git clone https://github.com/quantmew/ripperdoc.git
cd ripperdoc
pip install -e .

Verify Installation

ripperdoc --version

You should see the version number. Now run:

ripperdoc

This will start an interactive session. On first launch, Ripperdoc will guide you through setting your LLM endpoint. After that, type a message to begin chatting with the AI.

Shell Completion (Optional)

Ripperdoc supports shell completion for bash and zsh:

# For bash
eval "$(ripperdoc --completion bash)"

# For zsh
eval "$(ripperdoc --completion zsh)"

Add the appropriate line to your shell's rc file (.bashrc or .zshrc) to enable completion permanently.

Next Steps

• Quickstart - Start using Ripperdoc
• Configuration - Customize Ripperdoc settings