# aio - Streamlined AI Terminal Interactions Welcome to the README for the `aio` command line tool – your gateway to seamless communication with AI engines via the terminal. This tool streamlines interactions with AI APIs, including the OpenAI API, and conveniently formats the results using integrated Markdown formatting. Whether you're seeking information, generating content, or experimenting with AI, `aio` has you covered.
## 0.9 BREAKING CHANGES `aio` command line argument changed to be more ergonomic. See [the Argument manifest](./docs/ARGS.md) for more information about the new interface. ## 0.8 BREAKING CHANGES The default credentials path has changed from `~/.config/aio/creds.yml` to `~/.cache/aio/creds.yml`. ## Table of Contents - [aio - Streamlined AI Terminal Interactions](#aio---streamlined-ai-terminal-interactions) - [0.9 BREAKING CHANGES](#09-breaking-changes) - [0.8 BREAKING CHANGES](#08-breaking-changes) - [Table of Contents](#table-of-contents) - [NEW : Run code from code blocks](#new--run-code-from-code-blocks) - [Introduction](#introduction) - [Installation](#installation) - [Install from crates.io](#install-from-cratesio) - [Install from GitHub releases](#install-from-github-releases) - [Install from source](#install-from-source) - [Usage](#usage) - [Arguments](#arguments) - [Configuration](#configuration) - [Credentials](#credentials) - [Examples](#examples) - [Aliases](#aliases) - [Contributing](#contributing) ## NEW : Run code from code blocks You can now run code from code blocks using the flag `-r|--run`
## Introduction The `aio` command line tool is designed to simplify your interactions with AI engines by providing an intuitive interface directly within your terminal. Harness the power of large language models such as the OpenAI API without leaving your command line environment. ## Installation ## Install from crates.io You can now install aio from crates.io using the following command: ``` cargo install aio-cli ``` The program will be installed to your `~/.cargo/bin` directory. ### Install from GitHub releases To install `aio`, follow these steps: 1. Download the [latest release](https://github.com/glcraft/aio/releases/latest) based on your operating system and architecture. 2. Extract the downloaded archive. 3. (optional) Add the path of the directory where the binary was extracted to your `PATH`. Write this in your `~/.bashrc` or `~/.zshrc` (or `~/.zshenv`): ```sh PATH=/path/to/aio/bin:$PATH ``` or you can copy the `aio` executable into your `/usr/local/bin`. ```sh # sudo may be required sudo cp aio /usr/local/bin ``` ### Install from source To install `aio`, follow these steps: 1. **Prerequisites**: Make sure you have Rust installed on your system. If not, you can [install Rust](https://www.rust-lang.org/tools/install). 2. **Clone Repository**: Clone the `aio` repository to your local machine: ```sh git clone https://github.com/yourusername/aio.git ``` 3. **Build and Install**: Navigate to the `aio` directory and build the tool: ```sh cd aio cargo install --path . ``` ## Usage Using `aio` is straightforward. In your terminal, simply invoke the tool with appropriate arguments to communicate with AI engines and receive formatted responses. ```sh aio --engine openai:ask "Write an informative article about space exploration." ``` ## Arguments The `aio` command line tool supports the following arguments: - `--config_path`: Path to the configuration file. Default is `~/.config/aio/config.yaml`. - `--creds_path`: Path to the credentials file. Default is `~/.config/aio/creds.yaml`. - `-e|--engine