koios

Crates.iokoios
lib.rskoios
version0.1.1
sourcesrc
created_at2023-03-25 03:38:27.315949
updated_at2023-03-25 04:10:10.363876
descriptionA CLI tool to interact with the ChatGPT API and allow it to run commands on your machine to help you out.
homepage
repositoryhttps://github.com/shivam-sh/koi/
max_upload_size
id819900
size51,001
Shivam Sharma (shivam-sh)

documentation

README

Koi

What is Koi?

Koi is a simple tool built to let you use ChatGPT through the command line. It adds the ability to let ChatGPT run commands on your computer in order to help you out, or to help you out with complicated tasks.

How do I use Koi?

Koi is a simple tool to use. You can use it by running the following command:

koi -a <OPENAI_API_KEY>

This will open up a prompt for you to start asking questions.

You can edit the configuration file to pre-fill the API key so you don't have to enter it every time, allowing you to just run koi to start using it.

Installation

Cargo

To install Koi using Cargo, you can run the following command in your terminal:

cargo install koios

You will need to have Rust installed in order to install Koi from source.

From Source

To install Koi from source, you can run the following commands in your terminal:

cd koi
git clone https://github.com/shivam-sh/koi.git
cargo install --path .

You will need to have Rust installed in order to install Koi from source.

Download

  • Download binaries for popular platforms from the releases page
  • Unzip the file with tar -xvf <file>.tar.gz
  • Move the binary to a directory in your PATH environment variable

On macOS, you may get an error saying that the binary is from an unidentified developer. To fix this, you can run the following command:

sudo xattr -r -d com.apple.quarantine <path to binary>

You can also just right click on the binary and click "Open" to open it for the first time.

Contributing

If you would like to contribute to Koi, you can do so by opening a pull request on the GitHub repository.

Commit count: 39

cargo fmt