thejoker.msk/iris-context
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: add auto-start setup instructions

Browse Source
This commit is contained in:
verse91
2026-08-05 00:06:13 +07:00
parent d299d1c7c7
commit 53f104577f
1 changed files with 7 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+7 -10
View File
@@ -242,28 +242,25 @@ iris uninstall
> [!WARNING] > [!WARNING]
> **IRIS may cause visual conflicts and keybinding overlaps with other shell autosuggestion plugins or third-party completion tools. To prevent this, please disable them safely (e.g., zsh-autosuggestions, zsh-autocomplete, atuin, flyline, ...)** > **IRIS may cause visual conflicts and keybinding overlaps with other shell autosuggestion plugins or third-party completion tools. To prevent this, please disable them safely (e.g., zsh-autosuggestions, zsh-autocomplete, atuin, flyline, ...)**
Add an alias to your shell configuration file to launch IRIS easily: ### Auto-start IRIS on shell init
To automatically start IRIS every time you open a new shell session, add the init command to your shell config:
**Zsh (`~/.zshrc`):** **Zsh (`~/.zshrc`):**
```zsh ```zsh
if command -v iris >/dev/null 2>&1; then eval "$(iris init zsh)"
alias i="iris"
fi
``` ```
**Bash (`~/.bashrc`):** **Bash (`~/.bashrc`):**
```bash ```bash
if command -v iris >/dev/null 2>&1; then eval "$(iris init bash)"
alias i="iris"
fi
``` ```
**Fish (`~/.config/fish/config.fish`):** **Fish (`~/.config/fish/config.fish`):**
```fish ```fish
if command -v iris >/dev/null 2>&1 iris init fish | source
alias i="iris"
end
``` ```
## Configuration guide ## Configuration guide
IRIS uses a clean TOML configuration file located at `~/.config/iris/config.toml` IRIS uses a clean TOML configuration file located at `~/.config/iris/config.toml`