Gpt
A CLI and TUI(WIP) for chatGPT built with Rust. And offer a core crate for chatGPT app.
Install / Use
/learn @kingwingfly/GptREADME
<a name="readme-top"></a>
<!-- PROJECT SHIELDS --> <!-- PROJECT LOGO --> <br /> <div align="center"> <a href="https://github.com/kingwingfly/gpt"> <img src="images/logo.png" alt="Logo" width="80" height="80"> </a> <h3 align="center">gpt_ui</h3> <p align="center"> A CLI and TUI for chatGPT built with Rust. And offer a core crate for chatGPT app. <br /> <a href="https://github.com/kingwingfly/gpt"><strong>Explore the docs »</strong></a> <br /> <br /> <a href="https://github.com/kingwingfly/gpt">View Demo</a> · <a href="https://github.com/kingwingfly/gpt/issues/new?labels=bug&template=bug-report---.md">Report Bug</a> · <a href="https://github.com/kingwingfly/gpt/issues/new?labels=enhancement&template=feature-request---.md">Request Feature</a> </p> </div> <!-- TABLE OF CONTENTS --> <details> <summary>Table of Contents</summary> <ol> <li> <a href="#about-the-project">About The Project</a> <ul> <li><a href="#built-with">Built With</a></li> </ul> </li> <li> <a href="#getting-started">Getting Started</a> <ul> <li><a href="#prerequisites">Prerequisites</a></li> <li><a href="#installation">Installation</a></li> </ul> </li> <li><a href="#usage">Usage</a></li> <li><a href="#roadmap">Roadmap</a></li> <li><a href="#contributing">Contributing</a></li> <li><a href="#license">License</a></li> <li><a href="#contact">Contact</a></li> <li><a href="#acknowledgments">Acknowledgments</a></li> </ol> </details> <!-- ABOUT THE PROJECT -->About The Project
Support openAI chatGPT, llama and DeepSeek.
<p align="right">(<a href="#readme-top">back to top</a>)</p>Built With
<p align="right">(<a href="#readme-top">back to top</a>)</p> <!-- GETTING STARTED -->Getting Started
Download in release page or compile it yourself.
For api invoke endpoint:
- openAI: https://api.openai.com/v1/chat/completions
- github developer: https://models.inference.ai.azure.com/chat/completions
- DeepSeek: https://api.deepseek.com/chat/completions
others help youself.
For windows users, there's bug upstream when handling ctrl-c, you can quit by press ESC.
Usage
# start chatting
gpt_cli
# config
gpt_cli config
# quit
ESC
For more examples, please refer to the Documentation
<p align="right">(<a href="#readme-top">back to top</a>)</p>Compile it yourself
Prerequisites
- Install Rust
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
Compilation
- Clone the repo
git clone https://github.com/kingwingfly/gpt.git - Compilation
cargo build --bin gpt_cli --features cli --release
Roadmap
- [ ] Feature
See the open issues for a full list of proposed features (and known issues).
<p align="right">(<a href="#readme-top">back to top</a>)</p> <!-- CONTRIBUTING -->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!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
License
Distributed under the MIT License. See LICENSE.txt for more information.
Contact
Louis - 836250617@qq.com
Project Link: https://github.com/kingwingfly/gpt
<p align="right">(<a href="#readme-top">back to top</a>)</p> <!-- ACKNOWLEDGMENTS -->
