acseo/ai-phpdoc repository overview

AI PHPDocs is a tool that uses GPT-3 to automatically add missing PHPDoc comments to your PHP code.

https://github.com/acseo/ai-phpdoc⁠

⁠Prerequisites

This package uses the OpenAI API. Before using AI PHPDocs, you will need to have an OpenAI API key set as an environment variable.

⁠Usage

You can use the Docker image acseo/ai-phpdoc to use ai-phpdoc via docker

To add missing PHPDoc comments to a single file, use the following command:

docker run -it -e OPENAI_KEY=sk-xxx -v /path/to/your/code:/code acseo/ai-phpdoc file  /code/path/to/file.php

To add missing PHPDoc comments to a directory of files, use the following command. By default it iterates through the current directory for all files, but does not go into subdirectories:

docker run -it -e OPENAI_KEY=sk-xxx -v /path/to/your/code:/code acseo/ai-phpdoc dir /code

You may set the --recursive flag, or -r for short for it to go into subdirectories.

If you pass another variable (regardless of the recursive flag) it will treat it as another directory to sweep through instead of the working directory.

docker run -it -e OPENAI_KEY=sk-xxx -v /path/to/your/code:/code acseo/ai-phpdoc dir -r /code/src

⁠License

AI PHPDocs is licensed under the AGPL-3.0 license. See LICENSE for more information.