Copyedit text from the CLI using AI
- Copyedit text using AI models via the command line
- Support for multiple LLM providers through the
llmlibrary - Stream responses as they're generated or get complete responses
- Read from files or stdin
Manage your isolated LLM configuration directly through copyedit:
copyedit self install- Install LLM plugins from PyPIcopyedit self uninstall- Uninstall LLM pluginscopyedit self plugins- List and manage installed pluginscopyedit self keys- Manage API keys for different model providerscopyedit self templates- Manage prompt templatescopyedit self models- List and configure available modelscopyedit self aliases- Create shortcuts for frequently used modelscopyedit self schemas- Manage stored schemas
All commands operate within copyedit's isolated configuration directory, preventing conflicts with system-wide llm installations.
# Install Anthropic plugin
copyedit self install llm-anthropic
# Set up API key
copyedit self keys set anthropic
# Enter your API key when prompted
# Create an alias for convenience
copyedit self aliases set sonnet claude-sonnet-4.5
# Use Claude to copyedit
copyedit --model sonnet article.txt# Install Ollama plugin
copyedit self install llm-ollama
# List available Ollama models
copyedit self models list
# Use a local model
copyedit --model llama3.2 draft.txtTBD: publishing a package to PyPI.
uvx --from git+https://github.com/crossjam/copyedit_ai copyedit --helpuv tool install git+https://github.com/crossjam/copyedit_aiThe CLI can be invoked using either copyedit or copyedit_ai:
copyedit --help
# or
copyedit_ai --helpThe author prefers copyedit
This project and it's virtual environment is managed using uv and
is configured to support automatic activation of virtual environments
using direnv. Development activites such as linting and testing
are automated via Poe The Poet, run poe after cloning
this repo.
git clone https://github.com/crossjam/copyedit_ai
cd copyedit_aiuv venvuv syncpoe --helpThis project uses automated release management with GitHub Actions:
poe publish_patch- Bump patch version, commit, tag, and pushpoe publish_minor- Bump minor version, commit, tag, and pushpoe publish_major- Bump major version, commit, tag, and push
poe changelog- Generate changelog since last tagpoe release-notes- Generate release notes file
When you push a version tag (e.g., v1.0.0), the unified GitHub Actions workflow will:
- Test - Run tests across all supported Python versions and OS combinations
- Publish - Build and publish to PyPI (only if tests pass)
- GitHub Release - Create GitHub release with auto-generated notes and artifacts (only if PyPI publish succeeds)
This ensures a complete release pipeline where each step depends on the previous step's success.
poe docs-serve- Serve documentation locallypoe docs-build- Build documentationpoe docs-deploy- Deploy to GitHub Pages
The template includes MkDocs with material theme and automatic deployment to GitHub Pages.