The inir command
Everything you can type after inir, read from the command itself each time this site is built. inir help shows the same list, and inir <command> --help the details of one. Shell actions (inir <target> <function>) are on the IPC page.
Start here
Section titled “Start here”inir run
Section titled “inir run”Run the shell; inir run – CMD runs CMD with a live notification
| Option | What it does |
|---|---|
--daemon |
In the background |
--foreground |
In this terminal |
--session |
As the session service starts it |
-c <PATH>, --config <PATH> |
Shell directory to use |
inir settings
Section titled “inir settings”Toggle settings
| Option | What it does |
|---|---|
-c <PATH>, --config <PATH> |
Shell directory to use |
inir welcome
Section titled “inir welcome”Open the welcome tour again
| Option | What it does |
|---|---|
-c <PATH>, --config <PATH> |
Shell directory to use |
inir doctor
Section titled “inir doctor”Check the install and fix what it can
| Option | What it does |
|---|---|
--check |
Only check, change nothing |
--json |
The report as JSON |
--offline |
Do not fetch the repo’s remote |
--only <STEPS> |
Just these steps (–only=5,8) |
--perf |
Snapshot of graphics and media at runtime |
--fix-abi |
Rebuild Quickshell against the installed Qt |
--yes |
Rebuild without asking |
-c <PATH>, --config <PATH> |
Shell directory to use |
inir update
Section titled “inir update”Pull the latest iNiR, sync and restart
| Option | What it does |
|---|---|
--yes |
Take each question’s default answer |
--quiet |
Print less |
--local |
Sync this checkout, no git pull |
--realign |
Realign an old checkout after rewritten history |
--dry-run |
Say what would change, change nothing |
inir logs
Section titled “inir logs”Runtime logs
| Option | What it does |
|---|---|
--issues |
Every warning and error since start, grouped |
-n <N>, --lines <N> |
Last N lines |
--full |
All categories |
--debug |
Run in the foreground with debug output |
inir status
Section titled “inir status”Install mode, update strategy and health
The shell
Section titled “The shell”inir start
Section titled “inir start”Start the shell
| Option | What it does |
|---|---|
-c <PATH>, --config <PATH> |
Shell directory to use |
inir stop
Section titled “inir stop”Stop the shell
| Option | What it does |
|---|---|
-c <PATH>, --config <PATH> |
Shell directory to use |
inir restart
Section titled “inir restart”Restart the shell
| Option | What it does |
|---|---|
--quiet |
Print less |
-c <PATH>, --config <PATH> |
Shell directory to use |
inir repair
Section titled “inir repair”Doctor, restart and recent logs
| Option | What it does |
|---|---|
-c <PATH>, --config <PATH> |
Shell directory to use |
Make it yours
Section titled “Make it yours”inir theme
Section titled “inir theme”Theming targets for other apps
inir theme |
What it does |
|---|---|
list-targets |
List declared theming targets |
inspect |
Manifest, module and inputs of a target |
doctor |
Validate all targets or one |
scaffold |
Create a target manifest and module stub--label <TEXT>, --category <NAME>, --inputs <LIST> |
apply |
Apply one or more targets, or all |
inir look
Section titled “inir look”Your whole look in one file: share it, apply one, go back
inir look |
What it does |
|---|---|
export |
Write your look to FILE (stdout when piped or -)--name <NAME>, --wallpaper <URL> |
import |
Apply a look file or https link, with a snapshot first--dry-run, --no-wallpaper |
history |
Snapshots taken before each import or restore--json |
restore |
Go back to snapshot N of the history--dry-run, --no-wallpaper |
inir hub
Section titled “inir hub”Community hub: widgets, themes, web apps
| Option | What it does |
|---|---|
--json |
As JSON |
inir hub |
What it does |
|---|---|
list |
What the hub has--installed, --updates, --kind <widget|theme|iris-theme|webapp|family|component|design> |
search |
Search by text |
info |
One item in detail |
install |
Install items |
update |
Update items, or all |
remove |
Remove items |
social |
Publish your votes, reactions and installs |
counts |
What everyone else did with each item, from the relays now--max-age <SECONDS> |
sync |
Fetch the catalogue |
status |
Catalogue age and source--max-age <SECONDS>, --cached |
sources |
Where the catalogue comes from |
open |
Open the hub page, or one item |
refresh |
Tell the shell to read the hub again |
changed |
Tell the shell a kind changed |
check |
What CI runs on a pull request, run before sending it--base <REF>, --maintainer |
validate |
Check a hub repo’s items |
audit |
What each item may do, reaches, and its quality score--markdown |
bumps |
Changed items raise their version |
new |
Start an item from a template |
build |
Build a hub repo’s catalogue--out <DIR>, --packages-at <URL> |
stats |
Gather downloads, installs, votes and reactions into stats.json--repo <OWNER/NAME>, --no-relays, --out <FILE> |
submit |
Send an item to the hub as a pull request--dry-run |
preview |
Frame a widget’s preview |
inir bind
Section titled “inir bind”Make a Niri keybind for any inir call
| Option | What it does |
|---|---|
--add |
Write the bind into your own block of 90-user-extra.kdl |
--remove |
Take a bind you added back out |
--list |
The binds you added |
--examples <iris|ii|waffle|all> |
Ready binds for what people do most |
inir config
Section titled “inir config”View and edit shell settings
inir completions
Section titled “inir completions”Shell completions
inir completions |
What it does |
|---|---|
bash |
Print the bash completion |
zsh |
Print the zsh completion |
fish |
Print the fish completion |
install |
Install them where your shell looks |
inir hook
Section titled “inir hook”Live notifications for long commands in your shell
inir hook |
What it does |
|---|---|
bash |
eval “$(inir hook bash)” in ~/.bashrc--after <SECONDS> |
zsh |
eval “$(inir hook zsh)” in ~/.zshrc--after <SECONDS> |
fish |
inir hook fish | source in config.fish--after <SECONDS> |
Open things
Section titled “Open things”inir terminal
Section titled “inir terminal”Open the terminal
| Option | What it does |
|---|---|
-c <PATH>, --config <PATH> |
Shell directory to use |
inir browser
Section titled “inir browser”Open the browser
| Option | What it does |
|---|---|
-c <PATH>, --config <PATH> |
Shell directory to use |
inir colorpicker
Section titled “inir colorpicker”Pick a color from the screen
inir close-window
Section titled “inir close-window”Close the focused window
| Option | What it does |
|---|---|
-c <PATH>, --config <PATH> |
Shell directory to use |
Install and keep
Section titled “Install and keep”inir install
Section titled “inir install”Install iNiR: packages, config and files
| Option | What it does |
|---|---|
--yes |
Take each question’s default answer |
--quiet |
Print less |
--skip-deps |
Leave system packages alone |
--skip-setups |
Skip services and permissions |
--skip-files |
Skip copying config files |
--skip-quickshell |
Skip syncing the shell files |
--skip-niri |
Skip the Niri config |
--skip-backup |
No snapshot before installing |
--skip-sysupdate |
Skip the system upgrade first |
--no-audio |
Without the audio tools |
--no-toolkit |
Without ydotool and backlight tools |
--no-screencapture |
Without screenshots and recording |
--no-fonts |
Without fonts and themes |
--set-default-shell |
Make fish the default shell |
--firstrun |
Act as a first run, backing up configs |
--reset-dolphin-layout |
Reset Dolphin’s panel layout |
inir reinstall
Section titled “inir reinstall”Run the install again over this setup
| Option | What it does |
|---|---|
--yes |
Take each question’s default answer |
--quiet |
Print less |
inir rollback
Section titled “inir rollback”Restore a previous snapshot
inir my-changes
Section titled “inir my-changes”View or restore your preserved changes
inir backup
Section titled “inir backup”Create a manual snapshot
inir uninstall
Section titled “inir uninstall”Remove iNiR from the system
inir deps
Section titled “inir deps”What an install puts on this machine
inir deps |
What it does |
|---|---|
plan |
Packages and providers from the shell’s deps.toml--distro <arch|fedora|debian|ubuntu|void>, --no-audio, --no-toolkit, --no-screencapture, --no-fonts, --table <PATH>, --json |
install |
Install what the plan says is missing-y, --yes, --dry-run, --no-audio, --no-toolkit, --no-screencapture, --no-fonts |
inir webengine
Section titled “inir webengine”Get Qt WebEngine for the Web Apps tab
Under the hood
Section titled “Under the hood”inir service
Section titled “inir service”Manage the user service
inir service |
What it does |
|---|---|
install |
Install the service |
uninstall |
Remove the service |
enable |
Start it with the session |
disable |
Do not start it with the session |
start |
Start it now |
stop |
Stop it now |
restart |
Restart it |
status |
Whether it runs |
logs |
Its journal--full |
inir compositor
Section titled “inir compositor”Niri, Umbriel: where iNiR runs here
inir compositor |
What it does |
|---|---|
status |
What runs, what is installed, your pick |
add |
Set iNiR up on niri or umbriel |
remove |
Leave Umbriel as it is (remove umbriel) |
sync |
Your Niri keys and keyboard to Umbriel again |
inir info
Section titled “inir info”System and shell details
inir version
Section titled “inir version”Show the version
| Option | What it does |
|---|---|
--json |
As JSON |