CLI

Important

Python is not the fastest language, particularly when it comes to startup time.

You may notice a significant delay in the Ignis built-in CLI (around 160ms just to display the help message!). For better performance, there's an optional CLI written in Go: goignis, which offers excellent speed.

Run ignis --help to view the CLI usage help message.

ignis

A widget framework for building desktop shells, written and configurable in Python.

ignis [OPTIONS] COMMAND [ARGS]...

Options

--version

Print the version and exit.

close-window

Close a window.

ignis close-window [OPTIONS] WINDOW_NAME

Arguments

WINDOW_NAME

Required argument

init

Initialize Ignis.

ignis init [OPTIONS]

Options

-c, --config <PATH>

Path to the configuration file (default: ~/.config/ignis/config.py).

--debug

Print debug information to the terminal.

inspector

Open GTK Inspector.

ignis inspector [OPTIONS]

list-windows

List names of all windows.

ignis list-windows [OPTIONS]

open-window

Open a window.

ignis open-window [OPTIONS] WINDOW_NAME

Arguments

WINDOW_NAME

Required argument

quit

Quit Ignis.

ignis quit [OPTIONS]

reload

Reload Ignis.

ignis reload [OPTIONS]

run-file

Execute a Python file inside the running Ignis process.

ignis run-file [OPTIONS] FILE

Arguments

FILE

Required argument

run-python

Execute a Python code inside the running Ignis process.

ignis run-python [OPTIONS] CODE

Arguments

CODE

Required argument

systeminfo

Print system information.

ignis systeminfo [OPTIONS]

toggle-window

Toggle a window.

ignis toggle-window [OPTIONS] WINDOW_NAME

Arguments

WINDOW_NAME

Required argument