[xdg-desktop-portal] backend for choosing files with your favorite file chooser. By default, it will use the yazi file manager, but this is customizable. Based on [xdg-desktop-portal-wlr] (xdpw).
Having trouble with "Open in Folder" in your web browser’s download manager — where it doesn’t highlight the downloaded file or respect your file manager configuration?
If so, check out this file manager D-Bus service. There's a preview section to help you understand what it does: https://github.com/boydaihungst/org.freedesktop.FileManager1.common
By combining xdg-desktop-portal-termfilechooser with org.freedesktop.FileManager1.common,
you'll get a file-opening experience similar to macOS and Windows.
https://github.com/hunkyburrito/xdg-desktop-portal-termfilechooser
For Arch:
yay -S xdg-desktop-portal-termfilechooser-boydaihungst-git
On apt-based systems:
sudo apt install xdg-desktop-portal build-essential ninja-build meson libinih-dev libsystemd-dev scdoc
For Arch, see the dependencies in the AUR package.
git clone https://github.com/boydaihungst/xdg-desktop-portal-termfilechooser
-
Remove legacy files:
sudo rm -f "/usr/local/lib/systemd/user/xdg-desktop-portal-termfilechooser.service" sudo rm -f "/usr/local/lib64/systemd/user/xdg-desktop-portal-termfilechooser.service" sudo rm -f "/usr/local/libexec/xdg-desktop-portal-termfilechooser" sudo rm -f "/usr/local/share/dbus-1/services/org.freedesktop.impl.portal.desktop.termfilechooser.service" sudo rm -rf "/usr/local/share/xdg-desktop-portal-termfilechooser/" -
Build and install:
cd xdg-desktop-portal-termfilechooser meson build --prefix=/usr ninja -C build ninja -C build install # run with superuser privileges
Copy the config and any of the wrapper scripts in contrib dir to ~/.config/xdg-desktop-portal-termfilechooser. Edit the config file to set your preferred terminal emulator and file manager applications.
For terminal emulator. You can set the TERMCMD environment variable instead of edit wrapper file. So you only need to copy config. By default wrappers
is placed at /usr/share/xdg-desktop-portal-termfilechooser/
Example:
$HOME/.profile.bashrc
# use wezterm intead of kitty
export TERMCMD="wezterm start --always-new-process"-
$HOME/.config/xdg-desktop-portal-termfilechooser/configor$XDG_CONFIG_HOME/xdg-desktop-portal-termfilechooser/configUse yazi wrapper instead of ranger wrapper:[filechooser] cmd=/usr/share/xdg-desktop-portal-termfilechooser/yazi-wrapper.sh default_dir=$HOMEUse custom yazi wrapper instead of default wrapper:
[filechooser] cmd=$HOME/.config/xdg-desktop-portal-termfilechooser/yazi-wrapper.sh default_dir=$HOME or [filechooser] cmd=$XDG_CONFIG_HOME/xdg-desktop-portal-termfilechooser/yazi-wrapper.sh default_dir=$HOME
default_dir is where the app, which triggers download/upload or select file/folder, suggested to save file.
For example in firefox it's $HOME the first time, after successfully selected/saved file, it will remember the last selected location. This location is suggested by the app (e.g. firefox), not by xdg-desktop-portal-termfilechooser itself.
If your xdg-desktop-portal version
xdg-desktop-portal --version
# If xdg-desktop-portal not on $PATH, try:
/usr/libexec/xdg-desktop-portal --version
# OR, if it says file not found
/usr/libexec/xdg-desktop-portal --version
# OR
/usr/lib64/xdg-desktop-portal --version
# OR
/usr/lib64/xdg-desktop-portal --version
is >= 1.18.0, then you can specify the portal for FileChooser in ~/.config/xdg-desktop-portal/portals.conf file (see the flatpak docs and ArchWiki):
[preferred]
org.freedesktop.impl.portal.FileChooser=termfilechooser
If your xdg-desktop-portal --version is older, you can remove FileChooser from Interfaces of the {gtk;kde;…}.portal files:
find /usr/share/xdg-desktop-portal/portals -name '*.portal' -not -name 'termfilechooser.portal' \
-exec grep -q 'FileChooser' '{}' \; \
-exec sudo sed -i'.bak' 's/org\.freedesktop\.impl\.portal\.FileChooser;\?//g' '{}' \;
Restart the portal service:
systemctl --user restart xdg-desktop-portal.service
GTK_USE_PORTAL=1 zenity --file-selection
GTK_USE_PORTAL=1 zenity --file-selection --directory
GTK_USE_PORTAL=1 zenity --file-selection --multiple
Change `USER` to your `username`
GTK_USE_PORTAL=1 zenity --file-selection --save --filename='/home/USER/save_file_$.txt
and additional options: --multiple, --directory, --save.
-
After editing termfilechooser's config, restart its service:
systemctl --user restart xdg-desktop-portal-termfilechooser.service -
The termfilechooser's executable can also be launched directly:
systemctl --user stop xdg-desktop-portal-termfilechooser.service /usr/libexec/xdg-desktop-portal-termfilechooser -l TRACE -ror, if it says file/folder not found:
systemctl --user stop xdg-desktop-portal-termfilechooser.service /usr/lib64/xdg-desktop-portal-termfilechooser -l TRACE -r /usr/lib64/xdg-desktop-portal-termfilechooser -l TRACE -rThis way the output from the wrapper scripts (e.g.
ranger-wrapper.sh) will be written to the same terminal. This is handy for using e.g.set -xin the scripts during debugging. When termfilechooser runs as asystemdservice, its output can be viewer withjournalctl. Increase-n 1000(lines) to show more linesjournalctl -e -f --user -n 1000 -u xdg-desktop-portal-termfilechooser.service -
Since this merge request in GNOME,
GTK_USE_PORTAL=1seems to be replaced withGDK_DEBUG=portals. -
See also: Troubleshooting section in ArchWiki.
- Stop service:
systemctl --user stop xdg-desktop-portal-termfilechooser.service - Build and run in debug mode:
meson build --prefix=/usr --reconfigure && ninja -C build && ./build/xdg-desktop-portal-termfilechooser -l TRACE -r
Firefox has a setting in its about:config to always use XDG desktop portal's file chooser: set widget.use-xdg-desktop-portal.file-picker to 1. See https://wiki.archlinux.org/title/Firefox#XDG_Desktop_Portal_integration.
See man 5 xdg-desktop-portal-termfilechooser.
MIT
xdg-desktop-portal original author: GermainZ xdg-desktop-portal-wlr ranger yazi lf fzf nnn vifm