A CLI tool for developers using GPT-3.
Project description
Codegpt
0.3
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.
Your first (safe) command
One cool thing is generating documentation. GPT-3 has a token limit of 4000 for completions, so larger files will be chunked up.
codegpt docs <paths>
And it'll generate docs, one per file. This is great when you're coming into a codebase you've never seen before.
Unsafe Commands
Everything else can modify files. Have someone hold your beer and try some of these (after you check it into git):
Usage To try Codegpt, you can run the following command:
codegpt do <instructions (quoted)> -f readme.md
It can do basically anything. Try handing in some files for context and telling it to generate something new - SQL queries, new features, documentation, whatever.
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.
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.
Source Distribution
Built Distribution
File details
Details for the file codegpt-0.3.1.tar.gz
.
File metadata
- Download URL: codegpt-0.3.1.tar.gz
- Upload date:
- Size: 21.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.1.13 CPython/3.8.13 Linux/5.17.6-200.fc35.x86_64
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5cf7a553e91f814283c9198e2a6edc6827e1997a52b9da1efadfd6e95c31f542 |
|
MD5 | d101dc66f572b3ef734fad8cde7c3c02 |
|
BLAKE2b-256 | fbbb7db2ddf545ba1bcb4587e290189b9501089dcba5f2e053dd6ef7ae0d29c0 |
File details
Details for the file codegpt-0.3.1-py3-none-any.whl
.
File metadata
- Download URL: codegpt-0.3.1-py3-none-any.whl
- Upload date:
- Size: 22.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.1.13 CPython/3.8.13 Linux/5.17.6-200.fc35.x86_64
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7f5a0bc10aa610fe8a840ac5d75aee37bd51543e3b8234a74fc05967562733d1 |
|
MD5 | aa7330810943eb73806545445bfa95c7 |
|
BLAKE2b-256 | 91d3940fcfe71bd0082827bf8aef734a21715651735a6cb2bf01f6b6b18d162e |