This page documents the Aureli CLI tool (aureli). It acts as a runtime controller, IPC bridge, and configuration editor for the eqSh desktop.

The CLI is designed for:

• Developers scripting Aureli behavior
• Runtime control & debugging
• JSON config mutation
• Launching internal UI components
• Managing eqSh lifecycle

The CLI communicates with eqSh through:

• Quickshell execution
• Runtime IPC calls
• Direct JSON config edits

Binary¶

au [command] [options]

You can override the Aureli installation path:

au -l /custom/path run

Default:

~/.local/share/equora/eqsh

Runtime Paths¶

Core Commands¶

run¶

Start Aureli.

au run

Behavior:

• Prevents double launch
• Executes eqSh via Quickshell
• Detached by default

quit¶

au quit

Force kills Aureli using SIGKILL.

restart¶

au restart

Sequence:

1. Kill running instance
2. Relaunch eqSh

lock¶

au lock

Locks the screen.

update¶

au update

Git pulls eqSh repo.

install¶

Installs Aureli from GitHub.

au install

installWallpapers¶

Installs the default Aureli Wallpapers.

au installWallpapers

Configuration Commands¶

set¶

au set bar.height 40

Supports automatic type casting:

Nested paths use dot notation:

aureli set appearance.accentColor "#ff00ff"

Hot-reload occurs via eqSh file watchers.

get¶

au get bar.height

Special:

au get all

Lists top-level sections.

reset¶

Delete a config key.

au reset bar.height

Reset everything:

au reset --all

⚠ Requires restart.

UI Control Commands¶

These toggle or spawn UI systems.

Dialogs¶

Create system dialog:

au dialog <app> <icon> <title> <desc> <accept> <decline> <cmdA> <cmdD> <style>

Bridges to:

systemDialogs.newDialog

Notch Apps¶

Create¶

au new_notch_app MyApp.qml "Music"

Destroy¶

au destroy_notch_app

IPC Bridge¶

Generic IPC¶

au ipc <method> [args...]

Example:

au ipc eqlock lock

Show IPC Functions¶

au funcs

Lists exposed IPC endpoints.