yai

command module
v0.0.0-...-1fc8131 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 2, 2025 License: MIT Imports: 7 Imported by: 0

README

🚀 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, Google Gemini or Anthropic Claude 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://xsikor.github.io/yai/.

Quick start

To install Yai, simply run:

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

You can also choose your AI provider on the command line:

# Use OpenAI (default)
yai -p openai "list all docker containers"

# Use Google Gemini
yai -p gemini "show me all running processes"

# Use Anthropic Claude
yai -p claude "generate a random password"

# Use a specific model
yai -p gemini -model gemini-2.0-flash "explain kubernetes"
yai -p openai -model gpt-4 "optimize this algorithm"

At first run, it will ask you for an API key for your chosen provider, 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.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
ai
ui

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL