From 48a9f766a207c18a763165d5f81ee89ae707263d Mon Sep 17 00:00:00 2001 From: Vaibhav Date: Mon, 20 Mar 2023 02:01:52 -0500 Subject: [PATCH] rgpt: create page (#9918) * rgpt: create page * rgpt: fix formatting issues * rgpt: Have better formatting in the description Co-authored-by: K.B.Dharun Krishna * rgpt: better formatting for the verbose description Co-authored-by: K.B.Dharun Krishna * rgpt: rename gpt3 to gpt rename gpt3 to gpt because it now supports gpt3.5 --------- Co-authored-by: K.B.Dharun Krishna --- pages/common/rgpt.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 pages/common/rgpt.md diff --git a/pages/common/rgpt.md b/pages/common/rgpt.md new file mode 100644 index 0000000000..c93be6ae43 --- /dev/null +++ b/pages/common/rgpt.md @@ -0,0 +1,28 @@ +# rgpt + +> An automated code review tool that uses GPT you can use straight from your terminal. +> More information: . + +- Ask GPT to improve the code with no extra options: + +`rgpt --i "$(git diff {{path/to/file}})"` + +- Get a more detailed verbose output from `rgpt` while reviewing the code: + +`rgpt --v --i "$(git diff {{path/to/file}})"` + +- Ask GPT to improve the code and limit it to a certain amount of GPT3 tokens: + +`rgpt --max {{300}} --i "$(git diff {{path/to/file}})"` + +- Ask GPT for a more unique result using a float value between 0 and 2. (higher = more unique): + +`rgpt --pres {{1.2}} --i "$(git diff {{path/to/file}})"` + +- Ask GPT to review your code using a specific model: + +`rgpt --model {{text-davinci-003}} --i "$(git diff {{path/to/file}})"` + +- Make `rgpt` use a JSON output: + +`rgpt --json --i "$(git diff {{path/to/file}})"`