ggpt 0.1.4

Gorgeous CLI tools using GPT

ggpt

Gorgeous CLI tools using GPT.

Installation

pip install ggpt

Setup

1. Obtain an OpenAI API key at https://beta.openai.com/account/api-keys

2. Add it to your shell environment variables

   export OPENAI_API_KEY=<YOUR_API_KEY_HERE>
   

Usage

docstring

generates automated docstring based on code changes.

ggpt docstring [OPTIONS]

Option	Description
--api-key TEXT	OpenAI API Key. If not provided, OPENAI_API_KEY environment variable is used.
--path PATH	Path to the Git repository to search for code changes. If not provided, the current directory is used.
--hash TEXT	Hash of the commit to review. If not provided, unstaged changes are reviewed by default.
--staged	Include only staged changes in the review. If not provided, unstaged changes are reviewed by default.

https://user-images.githubusercontent.com/123562684/227761450-9297f709-3d61-448c-ad78-a04f9a5f41d8.mov

---

review

generates automated code review based on code changes.

ggpt review [OPTIONS]

Option	Description
--api-key TEXT	OpenAI API Key. If not provided, OPENAI_API_KEY environment variable is used.
--path PATH	Path to the Git repository to search for code changes. If not provided, the current directory is used.
--hash TEXT	Hash of the commit to review. If not provided, unstaged changes are reviewed by default.
--staged	Include only staged changes in the review. If not provided, unstaged changes are reviewed by default.

https://user-images.githubusercontent.com/123562684/227762097-1c42b186-014f-48fe-b116-ee5e6c39f9f7.mov

---

naming

suggests variable names based on submitted prompt.

ggpt naming PROMPT [OPTIONS]

Option	Description
--api-key TEXT	OpenAI API Key. If not provided, OPENAI_API_KEY environment variable is used.

https://user-images.githubusercontent.com/123562684/227763626-d329f156-c7f6-4a46-bfee-57504882d62c.mov

License

MIT LISENCE