1 unstable release

new 0.0.2 Jun 8, 2024

#418 in Command line utilities

Download history 145/week @ 2024-06-03

145 downloads per month

GPL-2.0 license

26KB
431 lines

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 classic TODO
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)

Stars

Star History Chart

Dependencies

~11–26MB
~396K SLoC