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

ignis [OPTIONS] COMMAND [ARGS]...

Options

--version

Print version and exit

close

Close window

ignis close [OPTIONS] WINDOW

Arguments

WINDOW

Required argument

init

Initialize Ignis

ignis init [OPTIONS]

Options

-c, --config <PATH>

Path to the configuration file (default: gi.repository.GLib.get_user_config_dir/ignis/config.py)

--debug

Print debug information to terminal

inspector

Open GTK Inspector

ignis inspector [OPTIONS]

list-windows

List all windows

ignis list-windows [OPTIONS]

open

Open window

ignis open [OPTIONS] WINDOW

Arguments

WINDOW

Required argument

quit

Quit Ignis

ignis quit [OPTIONS]

reload

Reload Ignis

ignis reload [OPTIONS]

run-file

Execute python file

ignis run-file [OPTIONS] FILE

Arguments

FILE

Required argument

run-python

Execute python code

ignis run-python [OPTIONS] CODE

Arguments

CODE

Required argument

systeminfo

Print system information

ignis systeminfo [OPTIONS]

toggle

Toggle window

ignis toggle [OPTIONS] WINDOW

Arguments

WINDOW

Required argument