https://github.com/255doesnotexist/ruskgpt
Yet another async AskGPT CLI client powered by Rust.
https://github.com/255doesnotexist/ruskgpt
askgpt chatgpt ruskgpt rust
Last synced: 2 months ago
JSON representation
Yet another async AskGPT CLI client powered by Rust.
- Host: GitHub
- URL: https://github.com/255doesnotexist/ruskgpt
- Owner: 255doesnotexist
- License: gpl-2.0
- Created: 2024-06-08T06:32:05.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-26T18:53:04.000Z (8 months ago)
- Last Synced: 2025-04-13T07:49:06.630Z (2 months ago)
- Topics: askgpt, chatgpt, ruskgpt, rust
- Language: Rust
- Homepage:
- Size: 65.4 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
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
- Shell workflows based on function calling (Still working in progress)
## Installation
To install `ruskgpt`, ensure you have Rust and Cargo installed. Then, run the following command:
```sh
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:
```sh
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:
```sh
ruskgpt -e
```
You can specify a configuration file with the --config option:
```sh
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](https://github.com/praeclarum/AskGPT), which [Jiang Yanyan](https://jyywiki.cn/) frequently used in his OS lectures.
## Supported Platforms
- Windows, Linux, macOS (x86, amd64, arm64)
## Stars
[](https://star-history.com/#255doesnotexist/ruskgpt)