LinuxCommandLibrary

kpackagetool6

Install, remove, and manage KDE Plasma packages

TLDR

List all known package types that can be installed

$ kpackagetool6 --list-types
copy

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

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

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

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

SYNOPSIS

kpackagetool6 [options] [arguments]

Examples:
  kpackagetool6 --list Plasma/Applet
  kpackagetool6 --install Plasma/Wallpaper /path/to/mywallpaper.zip
  kpackagetool6 --remove KWin/Script 'Blur My Walls'

PARAMETERS

--install <type> <path_or_url>
    Installs a package of the specified type from a local file path or URL.

--list <type>
    Lists all installed packages of the specified type.

--remove <type> <name_or_file>
    Removes an installed package of the specified type by its name or file.

--show <type> <name>
    Displays detailed information about an installed package.

--list-types
    Lists all supported package types that kpackagetool6 can manage.

--upgrade <type> <path_or_url>
    Upgrades an existing package of the specified type from a local file path or URL.

--global
    Operates on global (system-wide) packages instead of user-specific ones.

--version
    Shows the command's version information and exits.

--help
    Displays a help message with available options and exits.

DESCRIPTION

kpackagetool6 is a command-line utility provided by the KDE Plasma desktop environment. It's used for managing various types of Plasma packages, such as Plasma widgets (plasmoids), KWin scripts, Plasma themes, desktop themes, and KCM (KDE Control Module) modules. It allows users to install, list, remove, show details of, and upgrade these packages, primarily those downloaded from store.kde.org or local files. It serves as a programmatic interface for package management within the Plasma ecosystem, often used by developers or for scripting automated deployments. It is the successor to kpackagetool5 and is designed for KDE Plasma 6.

CAVEATS

Requires a KDE Plasma 6 environment for full functionality. Does not manage system-wide installed packages (e.g., those from distribution repositories), only those installed via KPackage or store.kde.org. Errors can be cryptic if dependencies are missing or package files are malformed.

AVAILABLE PACKAGE TYPES

Common types include Plasma/Applet (widgets), Plasma/Theme, KWin/Script, Plasma/Wallpaper, KPackage/Generic, and KCM (KDE Control Module). You can list all supported types using kpackagetool6 --list-types.

INSTALLATION SOURCE

Packages can be installed from local .zip files or directly from store.kde.org by providing the package's URL.

HISTORY

kpackagetool6 is the direct successor to kpackagetool5, which was used for managing Plasma 5 packages. With the release of KDE Plasma 6, a new major version of the tool was introduced to accommodate changes in the Plasma framework and ensure compatibility. Its development tracks the evolution of the KDE Plasma desktop.

SEE ALSO

kpackagetool5(1): The predecessor command for managing Plasma 5 packages., plasmapkg2(1): Another utility for Plasma package management, often aliased to kpackagetool or used for specific Plasma 5 contexts.

Copied to clipboard