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 [--global | --user] [-t <type>] <command> [arguments]

PARAMETERS

--global
    Operates on packages installed globally for all users (requires appropriate permissions).

--user
    Operates on packages installed for the current user only. This is often the default.

-t, --type <type>
    Specifies the type of package to operate on (e.g., 'Plasma/Wallpaper', 'Plasma/Theme', 'KCM', 'Konsole/ColorScheme'). Use 'gettypes' command to list supported types.

-h, --help
    Displays help on command line options.

--version
    Displays version information.

install <package_path_or_id>
    Installs a package from a local file path or a store ID. Requires the '--type' option.

remove <package_id>
    Removes an installed package identified by its ID. Requires the '--type' option.

list
    Lists all installed packages, optionally filtered by '--type'.

update
    Updates installed packages from their respective stores. Can be filtered by '--type'.

search <query>
    Searches for packages in online stores, optionally filtered by '--type'.

packagemanifest <package_path>
    Displays the manifest file (metadata) of a local package file.

gettypes
    Displays a list of all package types supported by the KPackage framework on the system.

DESCRIPTION

kpackagetool5 is a command-line utility provided by KDE Frameworks 5's KPackage module. Its primary purpose is to manage KPackage-style packages, which are self-contained bundles of resources like Plasma wallpapers, themes, widgets, KCM modules, Konsole color schemes, and other application-specific plugins. Unlike system-wide package managers (e.g., `apt`, `dnf`), kpackagetool5 focuses on user- or global-level assets used by KDE applications and the Plasma desktop. It allows users to install, remove, list, update, and search for these packages, often interacting with online repositories like store.kde.org.

CAVEATS

kpackagetool5 is specific to KDE Frameworks and is not a general Linux package manager. It manages assets and plugins for KDE applications, not system libraries or executables. Global installations (`--global`) may require root privileges or specific system configurations. The exact package types supported can vary depending on installed KDE applications and frameworks.

COMMON PACKAGE TYPES

Some frequently managed package types include:
Plasma/Wallpaper: Desktop wallpapers
Plasma/Theme: Plasma desktop themes
Plasma/Lookandfeel: Global Plasma look and feel packages
Plasma/Widget: Plasma desktop widgets
KCM: KDE Control Modules (settings panels)
Konsole/ColorScheme: Konsole terminal color schemes
ksplash/themes: Splash screen themes

INTEGRATION WITH KNEWSTUFF

kpackagetool5 often works in conjunction with the KNewStuff framework, which provides the infrastructure for applications to download and manage new content from online services (like store.kde.org). This allows users to easily extend their KDE experience with community-contributed content directly from the command line or through graphical interfaces like Plasma Discover.

HISTORY

kpackagetool5 is part of KDE Frameworks 5, representing the evolution of KDE's modularization efforts. It succeeded the older `kpackagetool` (for KDE 4), which managed similar assets in the KDE 4 ecosystem. The transition to KF5 brought a more streamlined and D-Bus-centric architecture, with `kpackagetool5` acting as the command-line interface to the KPackage and KNewStuff frameworks, facilitating the management of downloadable resources integrated directly into KDE applications.

SEE ALSO

kwriteconfig5(1), plasma-discover(8), kfmclient5(1)

Copied to clipboard