LinuxCommandLibrary

kscreen-console

Configure screen settings from the command line

TLDR

Show all outputs and configuration files to attach to a bug report

$ kscreen-console bug
copy

Show paths to KScreen configuration files
$ kscreen-console config
copy

Show KScreen output information and configuration
$ kscreen-console outputs
copy

Monitor for changes
$ kscreen-console monitor
copy

Show the current KScreen configuration as JSON
$ kscreen-console json
copy

Display help
$ kscreen-console [[-h|--help]]
copy

Display help including Qt specific command-line options
$ kscreen-console --help-all
copy

SYNOPSIS

kscreen-console [-l | --list] [-c | --current] [--help] [configId]

PARAMETERS

-l, --list
    List all available screen configurations with their IDs

-c, --current
    Output the ID of the currently active configuration

--help, -h
    Display command help and usage information

[configId]
    Numeric ID of configuration to apply (positional argument)

DESCRIPTION

kscreen-console is a command-line utility from the KScreen framework in KDE Plasma. It enables users to manage multi-monitor setups directly from the terminal. Key functions include listing all saved screen configurations, identifying the current active configuration ID, and applying a specific configuration by its numeric ID.

This tool is particularly useful for automation, scripting, or remote sessions where GUI access is unavailable. Configurations are stored by KScreen based on detected outputs (e.g., HDMI, DisplayPort) and user-defined profiles. Each config has a unique ID assigned sequentially.

To use, first list configs with -l, note the ID, then apply it. It communicates via DBus with the running KScreen service, so it requires an active Plasma session with KScreen enabled. No persistent changes outside session scope.

CAVEATS

Requires active KDE Plasma session with KScreen service running.
Does not create new configs; use GUI or kscreen-doctor for that.
Config IDs may change after hardware/output changes.

EXAMPLES

List configs: kscreen-console --list
Get current: kscreen-console --current
Apply config 3: kscreen-console 3

HISTORY

Introduced in KDE Plasma 5.4 as part of KScreen 1.0. Evolved with Plasma 5.x/6.x for better multi-monitor support. Maintained in kscreen package; largely supplemented by more featureful kscreen-doctor in later releases.

SEE ALSO

kscreen-doctor(1), kscreen(1), xrandr(1)

Copied to clipboard