gpt_ui

A CLI and TUI for chatGPT built with Rust. And offer a core crate for chatGPT app.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

(back to top)

Built With

• 

(back to top)

Getting Started

Download in release page or compile it yourself.

For windows users, there's bug upstream when handling ctrl-c, you can quit by press ESC.

Prerequisites

• Install Rust

  curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

Compilation

1. Clone the repo

   git clone https://github.com/kingwingfly/gpt.git

2. Compilation

   cargo build --bin gpt_cli --features cli --release

(back to top)

Usage

# start chatting
gpt_cli
# config
gpt_cli config
# quit
ESC

For more examples, please refer to the Documentation

(back to top)

Roadmap

• Feature

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Louis - [email protected]

Project Link: https://github.com/kingwingfly/gpt

(back to top)

Acknowledgments

• chatGPT stream rust demo

(back to top)