ruskgpt
| Crates.io | ruskgpt |
| lib.rs | ruskgpt |
| version | 0.0.3 |
| source | src |
| created_at | 2024-06-08 11:06:45.194494 |
| updated_at | 2024-07-17 15:15:45.251492 |
| description | Yet another async AskGPT CLI client powered by Rust. |
| homepage | |
| repository | https://github.com/255doesnotexist/ruskgpt/ |
| max_upload_size | |
| id | 1265681 |
| size | 92,675 |
255 (255doesnotexist)
documentation
README
Ruskgpt
Yet another async AskGPT CLI client powered by Rust.
Overview
ruskgpt is a command-line interface (CLI) client for interacting with GPT models asynchronously. It is built with Rust to provide high performance and reliability.
Features
- Asynchronous interactions with GPT models
- Configuration management
- Easy-to-use command-line interface
Installation
To install ruskgpt, ensure you have Rust and Cargo installed. Then, run the following command:
cargo install ruskgpt
Then put your OpenAI or other access token in configuration.
ruskgpt -e
Usage
Asking a Question
To ask a question, simply run:
ruskgpt "Why did the scarecrow win an award?"
# Because he was outstanding in his field!
Configuration
To open the configuration file in the default editor, use the -e or --edit option:
ruskgpt -e
To just set a configuration value, use the --set option:
ruskgpt --set key=value
You can specify a configuration file with the --config option:
ruskgpt --config path/to/config.toml
Supported LLM APIs
| API Provider | Supported | Notes |
|---|---|---|
| OpenAI | ✔️ | v1/chat/completions needed |
| OpenAI Like | ✔️ | v1/chat/completions needed |
| Claude | half | Experimental (new message API) |
| ChatGLM | ❌ | TODO |
| Qwen | ❌ | TODO |
| Gemini | ❌ | TODO |
| Deepseek | ❌ | TODO |
License
This project is licensed under the GPL-2.0 License - see the LICENSE file for details.
Authors
Inspirations
Inspired from praeclarum/AskGPT, which Jiang Yanyan frequently used in his OS lectures.
Supported Platforms
- Windows, Linux, macOS (x86, amd64, arm64)