Skip to content

Latest commit

 

History

History
75 lines (46 loc) · 1.65 KB

README.md

File metadata and controls

75 lines (46 loc) · 1.65 KB

ghr

made-with-rust

Generative Helper in Rust | GHR | - A command line tool to help developers generate boilerplate code templates.

🍬 Highlevel architechture/design

🕴 Preview

preview

🏃 Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Clone the repository.

git clone https://github.com/d1pankarmedhi/ghr.git

Build the project dependencies

cargo build

Make sure to set your openai key as environment variable

export OPENAI_API_KEY=<api-key>

Run project

cargo run

📎 Example

Generating Dockerfile template for a python fastapi server using ghr.

cargo run

Build and run Binary

You can run the main.py file or run the binary inside the target directory, produced after building the project.

Use cargo build --release to build a smaller and optimized binary for release.

Todo

  • OpenAI response processing
  • File saving
  • Error handling
  • Support for code template

🛠 Built With

📃 License

This project is licensed under the MIT License - see the LICENSE.md file for details