A CLI tool for refactoring code using OpenAI's models
Project description
Codegpt
0.2.0
A tool for using GPT just a little quicker. A nearly truly automated footgun. Learn how to revert with git before trying please.
Posting about progress here:
Getting Started
pip install codegpt --upgrade
And set your openapi API key as an environment variable like they recommend: In their docs here
Windows users can also use setx
like:
$ setx OPENAI_SECRET_KEY=<YOUR_API_KEY>
from an admin console.
Be careful! But try this
Usage To try Codegpt, you can run the following command:
codegpt do <filenames>
It will prompt you for directions to follow, and it'll do whatever you want. Write new docs, add comments to code, just make sure to ask it to "edit" or "comment" or whatever so it knows to change files or not.
Or use the quick command to do some neat stuff, like:
Generate docs
codegpt quick docs <filenames>
Change variable names to be more readable
codegpt quick varnames <filenames>
Add comments to your code automatically
codegpt quick comment <filenames>
Check for bugs (iffy, but worth a shot)
codegpt quick bugs <filenames>
Check for vulnerabilities (even more iffy, but worth a shot)
codegpt quick vulns <filenames>
Try to make code less miserable
codegpt quick ugh <filenames>
Keep in mind that using GPT-3 for code generation is paid, with a cost of 2 cents per 1,000 tokens.
Just like with a Jr Dev, it's best to break up your tasks into smaller pieces to improve the results.
Propose endpoints as issues, I've got a few ideas:
- Write tests for file
- Generate SQL query from table spec files
- Generate new file
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.