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.1.tar.gz (31.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.1-py3-none-any.whl (7.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: proofd-0.1.1.tar.gz
  • Upload date:
  • Size: 31.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.1.tar.gz
Algorithm Hash digest
SHA256 8c4738c59565959e19fd7e99480fe28e6ce7013e9c31b9054b6d00d5b7b5657e
MD5 3706a75ea0cd3606dd224e57ccaa479a
BLAKE2b-256 f840e93cbd1dcaefea6096199ff4d6a7ee449b5e180bc4f7939e21e756ac49fb

See more details on using hashes here.

Provenance

The following attestation bundles were made for proofd-0.1.1.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.1-py3-none-any.whl.

File metadata

  • Download URL: proofd-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 7.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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7491b6819724c942d5fec2d568a9d21474a91d82c236127198da0c95c5915727
MD5 a696f66ff303d828962d461e53805473
BLAKE2b-256 a410c58a19b6fbd5f1b71ec3673e28dafdd285598f5aad3457373d8ff6ce96b6

See more details on using hashes here.

Provenance

The following attestation bundles were made for proofd-0.1.1-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