logo

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

[![GitHub Actions](https://img.shields.io/github/actions/workflow/status/versenilvis/IRIS/release.yml?branch=main&style=for-the-badge&logo=github&logoColor=white&label=Actions)](https://github.com/versenilvis/IRIS/actions/workflows/release.yml) [![License: 0BSD](https://img.shields.io/badge/License-0BSD-blue?style=for-the-badge&logo=github&logoColor=white)](./LICENSE) Comparison ยท Installation ยท Docs ยท Shortcuts ยท 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) ## 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 - [Usage guide](./docs/README.md#usage-guide): core navigation, mode switching, instant alias expansion, and ghost text - [Configuration guide](./docs/README.md#configuration-guide): TOML configuration file structure, settings sections, and CLI commands - [Troubleshooting guide](./docs/README.md#troubleshooting-guide): debug mode, runtime log inspection, and common solutions - [Developer guide](./docs/development.md): system architecture overview, PTY bridge mechanics, and contribution instructions ## Shortcuts | Shortcut | Action | Description | | :--------------------------------- | :---------------------- | :------------------------------------------------------------------------ | | Shift + Tab | Toggle menu | Show or hide the suggestion menu. | | Esc | Hide menu | Temporarily hide the menu until the next key press. | | Tab | Accept suggestion | Insert the currently selected suggestion into the prompt. | | Enter | Execute command | Close the menu and send the current command to the shell. | | โ†‘ | Navigate up / history | Move the selection up, or open command history when the prompt is empty. | | โ†“ | Navigate down / history | Move the selection down, or open command history when the prompt is empty. | | โ†’ | Accept ghost text | Accept the faded ghost text suggestion when the menu is open. | | โ† / โ†’ | Move cursor | Move the cursor inside the input buffer. Disabled when the prompt is empty. | | Ctrl + R | Switch mode | Toggle between `spec` and `history` mode. | | Ctrl + A | Beginning of line | Move the cursor to the start of the command line. | | Ctrl + E | End of line | Move the cursor to the end of the command line. | | Ctrl + L | Clear screen | Clear the terminal while preserving the input buffer and redrawing the menu. | | Ctrl + U | Clear command | Remove the entire current command and close the menu. | | Ctrl + C | Cancel command | Send `SIGINT`, clear the input buffer, and close the menu. | | Ctrl + W | Delete word | Delete the word immediately before the cursor. | > [!NOTE] > With Ctrl + A, Ctrl + E, Ctrl + W, Ctrl + U, Ctrl + L, and Ctrl + C: they belong to your shell by default. IRIS handles them directly in raw mode so your cursor and menu stay in sync ## Reporting bugs > [!NOTE] > Describing the bug you are facing, along with the relevant log > Enabling debug mode and then performing actions that led to the error Run IRIS with debug mode: ```bash iris -d ``` or `config.toml`: ```toml debug=true ``` > [!IMPORTANT] > **Since IRIS logs everything you type, you should only enable debug mode when you need to report bugs** ## 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)