kupfer(1)

📦
version 329 · 7 versions
, in arch rolling, nixpkgs unstable

💖 NAME 💖

Hey bestie, welcome to kupfer(1) from the General Commands Manual! 👑 kupfer is the convenient command and access tool for applications and documents. Periodt. ✨

✨ SYNOPSIS ✨

kupfer [ OPTIONS | FILE ... ]
kupfer-exec FILE ...

🌸 DESCRIPTION 🌸

Kupfer is literally an interface for quick and convenient access to applications and their documents 💅. The most typical use is to find a specific application and launch it. We have tried to make Kupfer easy to extend with plugins so that this quick-access paradigm can be extended to many more objects than just applications. 🦋

kupfer-exec is a helper script that can execute commands saved to file, but only by connecting to an already running instance of Kupfer. No cap. 🫶

🦋 SPAWNING 🦋

Running kupfer on the command line (without options) will try to show the program if it’s already running. 👀

Kupfer can be invoked with a list of files:

kupfer FILE ...

The file paths will be sent to and selected in an already running instance of the program. 🎀

You may also pipe text to kupfer to pass it to a currently running instance. Pipes? Obsessed. 💜

💅 OPTIONS 💅

  • --no-splash — Launch without presenting main interface. 🙈
  • --debug — Enable more verbose output that can help understanding the program’s operation. 🔍
  • --list-plugins — List all installed plugins by their identifier, version and description. 📋

The following are options for internal use 👇

  • --exec-helper=HELPER — Run plugin helper program, which should be the name of a module inside kupfer.

The following are generic options 👇

  • --help — Display usage information. 🆘
  • --version — Display version information. ⭐

🎀 CONFIGURATION 🎀

Custom plugins are added to kupfer by installing them to the directory ~/.local/share/kupfer/plugins, or any kupfer/plugins directory in any of $XDG_DATA_DIRS. Drop ’em in and slay. 💖

🌈 ENVIRONMENT VARIABLES 🌈

  • If KUPFER_NO_CUSTOM_PLUGINS is set, only allow loading built-in plugins (installed in the program’s python package). 🔒
  • If KUPFER_NO_CACHE is set, do not load from or write to any source cache files. 🚫
  • If KUPFER_NO_KEYBINDER is set do not use Keybinder even if it is installed. ⌨️

💀 TROUBLESHOTING / KNOWN BUGS 💀

Wayland

Set GDK_BACKEND environment variable to x11 solve problem with wrong window position. 🪟

Some plugins (for example Windows) not work due to lack support by Wnck library. 😭

👑 Author 👑

Ulrik Sverdrup. 🫡

That’s the whole kupfer(1) moment, bestie — signed off with love, kupfer(1), 2017. 🫶💖✨

📦 where this page comes from