LinuxCommandLibrary

kpackagetool5

Install, uninstall, and manage KDE packages

TLDR

List all known package types that can be installed

$ kpackagetool5 --list-types
copy

Install the package from a directory
$ kpackagetool5 [[-t|--type]] [package_type] [[-i|--install]] [path/to/directory]
copy

Update installed package from a directory
$ kpackagetool5 [[-t|--type]] [package_type] [[-u|--upgrade]] [path/to/directory]
copy

List installed plasmoids (--global for all users)
$ kpackagetool5 [[-t|--type]] Plasma/Applet [[-l|--list]] [[-g|--global]]
copy

Remove a plasmoid by name
$ kpackagetool5 [[-t|--type]] Plasma/Applet [[-r|--remove]] "[name]"
copy

SYNOPSIS

kpackagetool5 [--type type] [--global] [{--list | --install path | --uninstall name | --test path}]

PARAMETERS

--type type
    Specifies package type (e.g. Plasma/Applet, Plasma/Runner, plasma-desktoptheme)

--global
    Install/uninstall system-wide (requires root privileges)

--list
    List all installed packages of the specified type

--install path
    Install package from directory or zip archive at path

--uninstall name
    Uninstall package by its metadata name

--test path
    Validate if path contains a valid package without installing

-q, --quiet
    Suppress non-error output messages

-h, --help
    Display usage help and exit

DESCRIPTION

kpackagetool5 is the command-line interface to the KPackage framework in KDE Plasma 5. It enables users to install, uninstall, list, and test packages such as plasmoids (applets), runners, dataengines, themes, and other Plasma components packaged in the KPackage format.

These packages extend Plasma's functionality and are installed to user-specific directories like ~/.local/share/plasma/plasmoids/ by default, or system-wide with --global. The tool validates package structure, metadata, and contents before installation. It supports both unpacked directories and zip archives.

Primarily used by advanced users or scripts, it provides precise control over Plasma extensions without relying on the GUI System Settings. Operations may require Plasma restart or kbuildsycoca5 rebuild for immediate effect. Package types are specified via --type, following conventions like Plasma/Applet for desktop widgets.

CAVEATS

Changes may not appear immediately; run kbuildsycoca5 --noincremental or plasmashell --replace &. System-wide ops need sudo. Deprecated in Plasma 6 (use kpackagetool6).

COMMON PACKAGE TYPES

Plasma/Applet: Desktop/taskbar widgets
Plasma/Runner: KRunner search plugins
Plasma/DataEngine: Data providers
plasma-desktoptheme: Icon/window themes
LookAndFeel: Full UI style packages

EXAMPLES

Install applet: kpackagetool5 --type Plasma/Applet --install ~/widget.zip
List applets: kpackagetool5 --type Plasma/Applet --list
Uninstall: kpackagetool5 --type Plasma/Applet --uninstall org.kde.plasma.myapplet

HISTORY

Introduced in KDE Plasma 5.4 (2015) with KPackage framework to replace legacy plasmapkg tool. Evolved for better modularity; succeeded by kpackagetool6 in Plasma 6 (2024).

SEE ALSO

kpackagetool6(1), kbuildsycoca5(8), plasmapkg2(1)

Copied to clipboard