Get Started

Setup Steps

1) Install the Python Package

python3 -m pip install copyaid

If you do not already have an OpenAI account, sign up at platform.openai.com/signup.

3) Set Up Your OpenAI API Key

To create an API key, visit platform.openai.com/api-keys.

OpenAI recommends exporting your API key as an environment variable named OPENAI_API_KEY. For instructions, see the OpenAI documentation.

Alternatively, you can reference your OpenAI API key from a personalized copyaid.toml configuration file. To learn how, consult the reference.

4) Quick Test

To ensure CopyAid is installed correctly, run:

copyaid --help

The output should begin with:

usage: copyaid [-h] [-c <config>] [-d <dest>] <task> <source> [<source> ...]

To verify that your OpenAI API access is working, perform the following test:

echo "Sofware dokumentashon are helpfull." > test.md
copyaid stomp test.md
# Expected output:
#   OpenAI request for test.md
#   Saving to /tmp/copyaid
cat test.md
# The file should now contain:
#   Software documentation is helpful.

Conclusion

You are now ready to perform copyediting tasks on your own source text files. Read the Tasks page to learn how.

Warning

Make sure to use copybreaks and/or ensure that your document consists of small text source files.