Skip to main content

TUI proofreader powered by Claude

Project description

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.

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

proofd-0.1.0.tar.gz (30.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

proofd-0.1.0-py3-none-any.whl (6.9 kB view details)

Uploaded Python 3

File details

Details for the file proofd-0.1.0.tar.gz.

File metadata

  • Download URL: proofd-0.1.0.tar.gz
  • Upload date:
  • Size: 30.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for proofd-0.1.0.tar.gz
Algorithm Hash digest
SHA256 8b8b7688a9d732c7b02f7f2168013ac45719a938743ad8db7863bf99fdbd6f00
MD5 5758f111d6a8469da347f9aa590de6bb
BLAKE2b-256 beb5085a194dd9560542df46422135f6b8d9e9dfd3113453259b3048764ccd7d

See more details on using hashes here.

Provenance

The following attestation bundles were made for proofd-0.1.0.tar.gz:

Publisher: publish.yml on luiul/proofd

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file proofd-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: proofd-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 6.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for proofd-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7aebb521b78d6b8558384b2043183e325082c5c9ada84fbfb1ab7eaaa78910e4
MD5 5e7cf746e610306699281dfdb6001cb0
BLAKE2b-256 6a71d1661b27b817d21c09e8cc278a39e40e9077d8576da190a9a26744d47050

See more details on using hashes here.

Provenance

The following attestation bundles were made for proofd-0.1.0-py3-none-any.whl:

Publisher: publish.yml on luiul/proofd

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page