Skip to content

CopyAid: Copyedit with AI from a CLI

CopyAid is an open-source command-line interface (CLI) utility that proofreads and copyedits text files using the OpenAI API for GPT, a Large Language Model capable of frequent, rapid, and extremely inexpensive copyediting (orders of magnitude cheaper than human copyediting).

Features

  • Supports Markdown, LaTeX, and reStructuredText formats.
  • Integrates with text file comparison tools such as vimdiff for reviewing and merging AI revisions.
  • Enables simultaneous file comparisons across multiple AI revisions.
  • Permits customization of programs to run automatically after AI revisions.
  • Allows customization of the copyediting instructions sent to OpenAI.
  • Includes systematically tested OpenAI prompts curated from more than a hundred test prompts and many thousands of OpenAI requests using CopyBlaster.

Get Started

Examples

Simple Example

$ echo "Use [this sofware](htp://copyaid.it) to wright English good." > doc.md
$ copyaid stomp doc.md
Saving revisions to /tmp/copyaid/R?/doc.md
 for source doc.md
$ cat doc.md
Use [this software](http://copyaid.it) to write English well.

Vimdiff Example

With the default configuration, the heavy task will request a pair of revisions from OpenAI and then run vimdiff for a 3-way diff of the original source and two revisions.

$ echo "Use [this sofware](htp://copyaid.it) to wright English good." > doc.md
$ copyaid heavy doc.md
Saving revisions to /tmp/copyaid/R?/doc.md
 for source doc.md
3 files to edit