Skip to content

luiul/proofd

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

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 / Action Description
Ctrl+Enter Run proofread
Ctrl+L Clear input and results
Ctrl+Q Quit
Audience selector team, leadership, cross-functional, external
Model selector haiku, sonnet, opus
Special instructions Optional free-text field for extra guidance
Copy button Copies that variant to clipboard

Environment variables

Variable Description
ANTHROPIC_API_KEY API key for direct Anthropic access
AWS_PROFILE AWS profile for Bedrock access
AWS_REGION / AWS_DEFAULT_REGION AWS region for Bedrock
ANTHROPIC_DEFAULT_HAIKU_MODEL Override the default Haiku model ID
ANTHROPIC_DEFAULT_SONNET_MODEL Override the default Sonnet model ID
ANTHROPIC_DEFAULT_OPUS_MODEL Override the default Opus model ID

About

TUI proofreader powered by Claude

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages