diff --git a/README.md b/README.md index 17307a0..1ea9a22 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,88 @@ -# CoderGPT +# CoderGPT CLI -A language agnostic code optimizer. +## Description + +CoderGPT CLI is a command line interface for CoderGPT, a state-of-the-art code generation tool. It allows developers to interact with the CoderGPT functionalities directly from the terminal, streamlining their workflow and enhancing productivity. + +## Author + +Harshad Hegde + +## Installation + +To use the CoderGPT CLI, clone the repository and install the required dependencies. + +```shell +pip install codergpt +``` + +## Usage + +Run the CLI using the following syntax: + +```shell +code [OPTIONS] COMMAND [ARGS]... +``` + +### Options + +- `-v, --verbose INTEGER`: Set verbosity level (0, 1, or 2). +- `-q, --quiet`: Enable quiet mode. +- `--version`: Display version information. + +### Commands + +#### inspect + +Inspect a package and display a file-language map. + +```shell +code inspect +``` + +#### explain + +Explain a specific function or class within a package. + +```shell +code explain [--function ] [--classname ] +``` + +#### comment + +Add comments to the code in a package. + +```shell +code comment [--overwrite/--no-overwrite] +``` + +## Development + +The CLI is built using Python and the `click` library. Below is an example of how to define a new command: + +```python +import click +from codergpt import CoderGPT + +coder = CoderGPT() + +@click.command() +@click.argument('path', type=click.Path(exists=True)) +def new_command(path): + # Command logic here + pass +``` + +## Contributing + +Contributions are welcome! Please read our contributing guidelines before submitting pull requests. + +## License + +This project is licensed under the MIT License - see the LICENSE.md file for details. # Acknowledgements This [cookiecutter](https://cookiecutter.readthedocs.io/en/stable/README.html) project was developed from the [monarch-project-template](https://github.com/monarch-initiative/monarch-project-template) template and will be kept up-to-date using [cruft](https://cruft.github.io/cruft/). + +For more information on CoderGPT CLI, please visit [the official documentation]().