logo

IRIS (Intelligent Real-time Input Suggestion) - A shell auto-completion tool that works like code editor's IntelliSense

[![macOS](https://img.shields.io/badge/macOS-FFFFFF?style=for-the-badge&logo=apple&logoColor=black)](https://www.apple.com/macos/) [![Linux](https://img.shields.io/badge/Linux-131415?style=for-the-badge&logo=linux&logoColor=white)](https://www.kernel.org/)
[![Status](https://img.shields.io/badge/status-beta-yellow?style=for-the-badge&logo=github&logoColor=white)]() [![License: 0BSD](https://img.shields.io/badge/License-0BSD-blue?style=for-the-badge&logo=github&logoColor=white)](./LICENSE) [![Documentation](https://img.shields.io/badge/docs-available-brightgreen?style=for-the-badge&logo=github&logoColor=white)](./docs/README.md) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen?style=for-the-badge&logo=github&logoColor=white)](./CONTRIBUTING.md) Comparison · Installation · Docs · Shortcuts · Configuration · Reporting bugs
Ghostty terminal showcase 👻 Ghostty terminal

**IRIS is built on top of TTY, so it runs everywhere. It just needs a terminal!** Run iris wherever you already work; your local machine, a remote server, or anywhere you can ssh. Each suggestion menu renders directly inline inside your real terminal session, not an app's imitation of one, so it never breaks full-screen TUIs or terminal formatting. Automatically index your aliases and shell history to suggest commands that match your actual workflow in real time. Change configurations and propagate them instantly without restarting your shell. One single local native Go binary, not an app: no gui, no electron, no mac-only wrapper, no account, no telemetry. (if you've used fig: it's that, rebuilt to run purely on TTY) ## AI suggestions
output IRIS has AI suggestions like your code editor (API key/Local)
## Why Iris instead of Fig > [!IMPORTANT] > **[Fig](https://app.fig.io/) was officially sunset in September 2024 and migrated to Amazon Q Developer (which requires cloud authentication and proprietary bloat)** > **IRIS is the lightweight, open-source, zero-telemetry alternative built purely on native Go and TTY with no accounts, no GUI app, and no background daemons required** ### How it compares | Feature | Iris | Fig | | :-------------------------- | :------------------- | :--------------- | | **Platforms** | Linux, macOS | macOS only | | **Engine** | Native Go (TTY) | Electron | | **Startup** | Near-zero overhead | Low overhead | | **UI** | Inline overlay | GUI popover | | **Remote SSH** | TTY-native, portable | macOS GUI-bound | | **Tmux** | ✓ | Limited | | **Linux virtual terminals** | ✓ | - | | **Memory** | < 15 MB | Electron runtime | ## Why not shell autocomplete plugins? Shell plugins are great, but they also come with trade-offs. And also, not everyone use Zsh or Fish especially on SSH. | Feature | Iris | Shell plugins | | :-------------------------- | :---------------------- | :--------------------------- | | **Installation** | Single binary | Plugin manager required | | **Shell support** | Most shells supported | Usually shell-specific | | **Startup** | No shell initialization | Increases shell startup time | | **SSH** | One config | Per-shell config | | **Tmux** | ✓ | Depends on the shell | | **Linux virtual terminals** | ✓ | Depends on the shell | ## Installation ```bash curl -sSL https://raw.githubusercontent.com/versenilvis/iris/main/scripts/install.sh | sh ``` > [!WARNING] > Currently, Windows is not supported ## Theme
Kitty terminal showcase 😺 Kitty terminal
> [!NOTE] > Currently, IRIS doesn't have custom theme but it does have 2 basic styles
Modern style Classic style
spec spec
history history
## Docs - [Getting started](./docs/README.md#getting-started): dependencies, installation methods, and shell integration setup - [Shortcuts](./docs/README.md#shortcuts): core navigation, shortcuts table, mode switching, and ghost text - [Configuration guide](./docs/README.md#configuration-guide): TOML configuration settings including AI provider options - [Reporting bugs](./docs/README.md#reporting-bugs): debug mode, log inspection, and crash reporting - [Developer documentation](./docs/dev/README.md): system architecture overview, engine design, and contribution guide ## License This project is licensed under the [0BSD License](LICENSE) - no strings attached. Meaning you can do whatever you want with it. For those who fork it and want to publish a new version or something else; if you can, a credit or co-author mention is always welcome :) (though never required). Thank you! ## Feedback I'd love to hear your feedback Feel free to reach out via: * [Email](mailto:versedev.store@proton.me) * [Twitter](https://twitter.com/versenilvis) * [GitHub issues](https://github.com/versenilvis/iris/issues/new)