Skip to content

CLI

A CLI tool to apply Wayland flags to Chromium-based applications.

Usage:

$ [OPTIONS] COMMAND [ARGS]...

Options:

  • --install-completion: Install completion for the current shell.
  • --show-completion: Show completion for the current shell, to copy it or customize the installation.
  • --help: Show this message and exit.

Commands:

  • apply: Apply Wayland flags to applications...
  • diff: Show what changes would be made to desktop...
  • clean: Clean up old backup files.
  • list: List all programs and their associated...
  • prune: Remove orphan desktop files from...
  • restore: Restore desktop files from a backup or...
  • status: Show current status of waylandify...
  • validate: Validate the configuration file.
  • verify: Verify that applied flags are still...
  • init: Create a default configuration file.

apply

Apply Wayland flags to applications defined in the config file.

Reads the configuration and modifies .desktop files for each program entry, adding the specified command-line flags.

Examples: $ waylandify apply --dry-run # Preview changes $ waylandify apply # Apply changes $ waylandify apply --interactive # Confirm each change $ waylandify apply --verbose # Show detailed output $ waylandify apply --prune # Apply and remove orphan files

Usage:

$ apply [OPTIONS]

Options:

  • -n, --dry-run: Show what would be changed without applying anything.
  • -i, --interactive: Confirm each change before applying.
  • -v, --verbose: Show detailed output for each file.
  • -p, --prune: Also remove orphan desktop files from uninstalled applications.
  • --help: Show this message and exit.

diff

Show what changes would be made to desktop files.

Displays a unified diff of the modifications that would be applied by the 'apply' command.

Examples: $ waylandify diff # Show all diffs $ waylandify diff "Electron Apps" # Show diff for specific program

Usage:

$ diff [OPTIONS] [PROGRAM_NAME]

Arguments:

  • [PROGRAM_NAME]: Show diff for a specific program only

Options:

  • --help: Show this message and exit.

clean

Clean up old backup files.

Remove backup files to free up disk space. You can remove all backups or only those older than a certain number of days.

Examples: $ waylandify clean # Show backup stats $ waylandify clean --older-than 30 # Remove backups older than 30 days $ waylandify clean --all # Remove all backups

Usage:

$ clean [OPTIONS]

Options:

  • -d, --older-than INTEGER: Remove backups older than N days.
  • -a, --all: Remove all backups.
  • --help: Show this message and exit.

list

List all programs and their associated desktop files.

Shows which programs from your configuration have matching .desktop files on your system.

Example: $ waylandify list

Usage:

$ list [OPTIONS]

Options:

  • --help: Show this message and exit.

prune

Remove orphan desktop files from uninstalled applications.

Detects and removes desktop files in ~/.local/share/applications whose executables no longer exist (application was uninstalled).

This is useful when: - You uninstall an application (like Vivaldi or a PWA) - The modified desktop file remains in ~/.local/share/applications - The system no longer has the original desktop file

Examples: $ waylandify prune --dry-run # Preview what would be removed $ waylandify prune # Remove orphans (with confirmation) $ waylandify prune --force # Remove orphans without confirmation

Usage:

$ prune [OPTIONS]

Options:

  • -n, --dry-run: Show what would be removed without actually removing anything.
  • -f, --force: Remove orphan files without confirmation.
  • --help: Show this message and exit.

restore

Restore desktop files from a backup or revert to system defaults.

Without arguments, lists available backups. With --remove-only, removes user desktop files to use system defaults. With a backup ID, restores files from that specific backup.

Examples: $ waylandify restore # List backups $ waylandify restore backup_20240101_120000 # Restore specific backup $ waylandify restore --remove-only # Remove all modified files

Usage:

$ restore [OPTIONS] [BACKUP_ID]

Arguments:

  • [BACKUP_ID]: Backup directory name to restore from (e.g., backup_20240101_120000_123456)

Options:

  • -r, --remove-only: Remove modified desktop files without restoring backups (reverts to system defaults)
  • --help: Show this message and exit.

status

Show current status of waylandify modifications.

Displays information about modified desktop files, available backups, and configuration status.

Example: $ waylandify status

Usage:

$ status [OPTIONS]

Options:

  • --help: Show this message and exit.

validate

Validate the configuration file.

Checks if the configuration file exists, is valid TOML, and conforms to the expected schema.

Example: $ waylandify validate

Usage:

$ validate [OPTIONS]

Options:

  • --help: Show this message and exit.

verify

Verify that applied flags are still present in desktop files.

Checks if the Wayland flags you configured are still present in the user desktop files. Useful after system updates that might overwrite your modifications.

Example: $ waylandify verify

Usage:

$ verify [OPTIONS]

Options:

  • --help: Show this message and exit.

init

Create a default configuration file.

Creates a configuration file at ~/.config/waylandify/config.toml (or $XDG_CONFIG_HOME/waylandify/config.toml if set).

Example: $ waylandify init

Usage:

$ init [OPTIONS]

Options:

  • --help: Show this message and exit.