From a0995921a7736b5479188cdbc122b39064627cae Mon Sep 17 00:00:00 2001 From: Harshad Hegde Date: Mon, 12 Feb 2024 14:06:13 -0600 Subject: [PATCH] updated docs --- docs/description.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/description.rst b/docs/description.rst index 97232e5..a8c8bc2 100644 --- a/docs/description.rst +++ b/docs/description.rst @@ -10,6 +10,17 @@ CoderGPT is a command line interface for generating/modifying code. It allows de enhance code by commenting, optimizing, documenting and adding tests to their projects using the power of LLM and GPT. This project is powered by `langchain `_. +.. note:: + **NOTE** + Before using CoderGPT, ensure that the environment variable ``OPENAI_API_KEY`` is set locally on your machine. This key is required for authentication with the OpenAI API which powers the underlying language model. + + .. code-block:: sh + + export OPENAI_API_KEY='your-api-key-here' + + Replace ``your-api-key-here`` with your actual OpenAI API key. This step is crucial for the proper functioning of CoderGPT as it relies on the OpenAI API for generating and modifying code. + + Installation ------------