No description
  • Python 85%
  • Shell 12.7%
  • Makefile 2.3%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
MeIsGaming 9e87d4645f
Some checks failed
Publish AUR Package / publish-aur (push) Has been cancelled
Markdown Lint / markdown (push) Has been cancelled
Python Lint / lint (3.11) (push) Has been cancelled
Python Lint / lint (3.12) (push) Has been cancelled
Shell Lint / shellcheck (push) Has been cancelled
Enhance command discovery and pagination in KRunner Spotify plugin; update documentation and command references
2026-02-20 01:54:53 +01:00
.github/workflows Enhance AUR publish workflow by adding secret validation, improving error messages, and ensuring consistent git configuration 2026-02-20 01:19:23 +01:00
docs Enhance command discovery and pagination in KRunner Spotify plugin; update documentation and command references 2026-02-20 01:54:53 +01:00
icons Add command structure and various command implementations for Spotify control 2026-02-19 23:59:17 +01:00
packaging Enhance command discovery and pagination in KRunner Spotify plugin; update documentation and command references 2026-02-20 01:54:53 +01:00
scripts Enhance KRunner Spotify with new features and improvements 2026-02-20 00:26:40 +01:00
src Enhance command discovery and pagination in KRunner Spotify plugin; update documentation and command references 2026-02-20 01:54:53 +01:00
tests Enhance KRunner Spotify with new features and improvements 2026-02-20 00:26:40 +01:00
wiki Enhance command discovery and pagination in KRunner Spotify plugin; update documentation and command references 2026-02-20 01:54:53 +01:00
.gitignore Enhance KRunner Spotify with new features and improvements 2026-02-20 00:26:40 +01:00
.markdownlint-cli2.yaml Enhance KRunner Spotify with new features and improvements 2026-02-20 00:26:40 +01:00
CHANGELOG.md Add command structure and various command implementations for Spotify control 2026-02-19 23:59:17 +01:00
CONTRIBUTING.md Add command structure and various command implementations for Spotify control 2026-02-19 23:59:17 +01:00
CREDITS.md Enhance KRunner Spotify with new features and improvements 2026-02-20 00:26:40 +01:00
debug.sh Add command structure and various command implementations for Spotify control 2026-02-19 23:59:17 +01:00
install.sh Add command structure and various command implementations for Spotify control 2026-02-19 23:59:17 +01:00
KRunner-Spotify.config Update Spotify configuration and enhance error handling in login command 2026-02-20 00:51:08 +01:00
krunner-spotify.systemd.service Add command structure and various command implementations for Spotify control 2026-02-19 23:59:17 +01:00
LICENSE Add command structure and various command implementations for Spotify control 2026-02-19 23:59:17 +01:00
Makefile Enhance KRunner Spotify with new features and improvements 2026-02-20 00:26:40 +01:00
org.kde.KRunnerSpotify.service Add command structure and various command implementations for Spotify control 2026-02-19 23:59:17 +01:00
plasma-runner-KRunnerSpotify.desktop Add command structure and various command implementations for Spotify control 2026-02-19 23:59:17 +01:00
pyrightconfig.json Add command structure and various command implementations for Spotify control 2026-02-19 23:59:17 +01:00
pytest.ini Enhance KRunner Spotify with new features and improvements 2026-02-20 00:26:40 +01:00
README.md Enhance command discovery and pagination in KRunner Spotify plugin; update documentation and command references 2026-02-20 01:54:53 +01:00
requirements.txt Add command structure and various command implementations for Spotify control 2026-02-19 23:59:17 +01:00
ruff.toml Add command structure and various command implementations for Spotify control 2026-02-19 23:59:17 +01:00
TODO.md Enhance KRunner Spotify with new features and improvements 2026-02-20 00:26:40 +01:00
uninstall.sh Add command structure and various command implementations for Spotify control 2026-02-19 23:59:17 +01:00
USAGE.md Enhance command discovery and pagination in KRunner Spotify plugin; update documentation and command references 2026-02-20 01:54:53 +01:00

KRunner SpotifyEnhanced

Control Spotify directly from KRunner using spe commands.

Highlights

  • Universal playback control across Spotify devices
  • Command prefix flow (spe play, spe next, spe pause, ...)
  • Search for songs, artists, playlists, podcasts, episodes
  • Queue management, seek, repeat, shuffle, volume, track info
  • Fork-maintained by Ashley (MeIsGaming) with upstream credits retained

Requirements

  • Linux with KDE Plasma / KRunner
  • Python 3.9+
  • python3-venv
  • pip

Install

git clone https://github.com/MeIsGaming/krunner-spotify.git
cd krunner-spotify
./install.sh

Optional install flags:

./install.sh --no-restart
./install.sh --python python3.12
./install.sh --skip-pip
./install.sh --no-systemd

Installer actions:

  • Creates .venv (if missing)
  • Installs Python dependencies
  • Installs KRunner DBus plugin metadata
  • Installs and starts a user systemd service (krunner-spotify.service) when available
  • Installs icons into ~/.local/share/pixmaps
  • Restarts KRunner if kquitapp6 is available

Verify Installation

After install, check these files exist:

  • ~/.local/share/krunner/dbusplugins/plasma-runner-KRunnerSpotify.desktop
  • ~/.local/share/dbus-1/services/org.kde.KRunnerSpotify.service
  • ~/.config/KRunner-Spotify/KRunner-Spotify.config

Then open KRunner and run:

spe login
spe trackinfo

Quick Usage

spe
spe help
spe list
spe ?
spe commands
spe list 2
spe list vol
spe list 2 vol
spe login
spe play bohemian rhapsody
spe next
spe pause
spe resume

KRunner often shows only the first ~10 visible results at once. Use paging for full list views:

spe list 1
spe list 2
spe list 3
spe list next
spe list prev

You can also filter command discovery by text:

spe list vol
spe help play
spe commands info

Full command reference: USAGE.md

Compatibility

  • Primary command prefix is spe.
  • Optional legacy alias mode (sp) can be enabled in config:
ENABLE_LEGACY_SP_ALIAS = True

Config file path:

  • ~/.config/KRunner-Spotify/KRunner-Spotify.config

Common Fixes

  • If only one suggestion appears when typing spe, restart KRunner and service:
kquitapp6 krunner
systemctl --user restart krunner-spotify.service
  • If commands still show 403, verify CLIENT_ID, REDIRECT_URI, and app user access in Spotify Dashboard.

Quality & Tests

make lint
make shellcheck
make docs-check
make test
make smoke

Optional integration tests (requires running DBus service):

make test-integration

Debug / Uninstall

./debug.sh
./uninstall.sh

Additional options:

./debug.sh --no-redeploy
./uninstall.sh --keep-config --keep-cache

If KRunner does not auto-activate the DBus service on your distro/session bus, the user systemd service keeps the runner available in the background.

Documentation

Maintainer

Credits

This repository is a maintained fork and keeps clear attribution:

License

Distributed under GPL-3.0. See LICENSE.