DESCRIBER: Description by AI

Generate a description of the tasks done to put in the pull request from your commits

Configure:

Add the environment variable OPENAI_TOKEN with your openai api key or add it to package.json

1{
2    ...
3    "gdescriber": {
4        "openai_token": "YOU-OPENAI-API-KEY"
5    }
6}

Run

Execute in you project folder

1npx gdescriber

Options

Pass parameters in the execution line

--origin

Change the origin branch to compare commits, example:

1npx gdescriber --origin develop

--prompt

Add new text to the AI ​​prompt, example:

1npx gdescriber --prompt "Considering that my project is an e-commerce in NextJS"