Skip to content

Latest commit

 

History

History
42 lines (25 loc) · 1.76 KB

README.md

File metadata and controls

42 lines (25 loc) · 1.76 KB
Raw

🚀 Yai 💬 - AI powered terminal assistant

build release doc

Unleash the power of artificial intelligence to streamline your command line experience.

Intro

What is Yai ?

Yai (your AI) is an assistant for your terminal, using OpenAI ChatGPT to build and run commands for you. You just need to describe them in your everyday language, it will take care or the rest.

You have any questions on random topics in mind? You can also ask Yai, and get the power of AI without leaving /home.

It is already aware of your:

  • operating system & distribution
  • username, shell & home directory
  • preferred editor

And you can also give any supplementary preferences to fine tune your experience.

Documentation

A complete documentation is available at https://ekkinox.github.io/yai/.

Quick start

To install Yai, simply run:

curl -sS https://raw.githubusercontent.com/ekkinox/yai/main/install.sh | bash

At first run, it will ask you for an OpenAI API key, and use it to create the configuration file in ~/.config/yai.json.

See documentation for more information.

Thanks

Thanks to @K-arch27 for the Yai name suggestion.