Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
hrshdhgd committed Feb 13, 2024
1 parent 7b0ce9b commit f707da2
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 6 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,10 @@ codergpt [OPTIONS] COMMAND [ARGS]...
- `-v, --verbose INTEGER`: Adjust the verbosity level (0 for default, 1 for verbose, 2 for debug).
- `-q, --quiet`: Suppress output.
- `--version`: Show the version number and exit.
- `--model`: Model to use for performing requests.
- Available models:
- OpenAI: [`gpt-3.5-turbo`, `gpt-4`, `gpt-4-turbo-preview`(default)]
- Google: [`gemini-pro`]

#### Commands

Expand All @@ -49,13 +53,13 @@ codergpt [OPTIONS] COMMAND [ARGS]...
Analyze a package and display its file-language mapping.

```shell
codergpt inspect <path>
codergpt --model <model-name> inspect <path>
```

###### Example

```shell
$ codergpt inspect src/codergpt/
$ codergpt --model gpt-4 inspect src/codergpt/
```

##### Explain
Expand Down
9 changes: 5 additions & 4 deletions docs/description.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Model Providers Implemented
The following model providers have been implemented in CoderGPT:

.. list-table::
:widths: 25 75
:widths: 75 25
:header-rows: 1

* - Provider
Expand All @@ -38,7 +38,7 @@ The following model providers have been implemented in CoderGPT:
export OPENAI_API_KEY='your-api-key-here'
export GOOGLE_API_KEY='your-api-key-here'
Replace ``your-api-key-here`` with your actual OpenAI and Google API keys. This step is crucial for the proper functioning of CoderGPT as it relies on OpenAI and Google APIs for generating and modifying code.
Replace ``your-api-key-here`` with your actual OpenAI and Google API keys. This step is crucial for the proper functioning of CoderGPT as it relies on OpenAI and Google APIs for generating and modifying code.

Installation
------------
Expand Down Expand Up @@ -78,6 +78,7 @@ Options
- ``-v, --verbose INTEGER``: Set verbosity level (0, 1, or 2).
- ``-q, --quiet``: Enable quiet mode.
- ``--version``: Display version information.
- ``--model [gpt-3.5-turbo | gpt-4 | gpt-4-turbo (default) | gemini-pro]``: Set the model provider to use.

Commands
~~~~~~~~
Expand All @@ -87,13 +88,13 @@ Commands

.. code-block:: shell
codergpt inspect <path>
codergpt --model <model-name> inspect <path>
**Example**

.. code-block:: shell
$ codergpt inspect src/codergpt/
$ codergpt --model gpt-4 inspect src/codergpt/
Inspecting the code.
File Language
------------------------------------------ ----------
Expand Down

0 comments on commit f707da2

Please sign in to comment.