Skip to content

Repository files navigation

proofd

A terminal UI proofreader powered by Claude. Paste your text, pick an audience and model, and get back three tone variants (concise, polished, verbose) with corrected spelling, grammar, and technical terminology. The polished variant is auto-copied to your clipboard.

Built for data/analytics engineers -- it understands terms like ETL, dbt, medallion architecture, and more.

Installation

Requires uv and an Anthropic API key (ANTHROPIC_API_KEY) or AWS credentials configured for Bedrock.

Install from PyPI:

uv tool install proofd

Or install from source:

uv tool install git+https://github.com/luiul/proofd.git

Then run it from anywhere:

proofd

Development

git clone https://github.com/luiul/proofd.git
cd proofd
uv sync
uv run proofd

To test local changes as an installed tool:

uv tool install --reinstall .

Controls

Key / ActionDescription
Ctrl+EnterRun proofread
Ctrl+LClear input and results
Ctrl+QQuit
Audience selectorteam, leadership, cross-functional, external
Model selectorhaiku, sonnet, opus
Special instructionsOptional free-text field for extra guidance
Copy buttonCopies that variant to clipboard

Environment variables

VariableDescription
ANTHROPIC_API_KEYAPI key for direct Anthropic access
AWS_PROFILEAWS profile for Bedrock access
AWS_REGION / AWS_DEFAULT_REGIONAWS region for Bedrock
ANTHROPIC_DEFAULT_HAIKU_MODELOverride the default Haiku model ID
ANTHROPIC_DEFAULT_SONNET_MODELOverride the default Sonnet model ID
ANTHROPIC_DEFAULT_OPUS_MODELOverride the default Opus model ID

About

TUI proofreader powered by Claude

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages