cd_quit not working and documentation doesn't clarify the need of spf function

[miguel-montes-lorenzo]

Bug description

I am trying to use the "cd_quit" hotkey and it doesn't work

To Reproduce

1. Set this config:

# config.toml
cd_on_quit = false  # doesn't work with true either

# hotkeys.toml
quit = ['q', 'esc']
cd_quit = ['Q', 'g']   # quit and cd (was 'Q' by default)

2. Enter superfile
3. Hit g or Q
4. Doesn't do anything :(

Expected behavior
Should exit spf to the selected path

System information (please complete the following information):

• OS: windows (wsl2)
• Version: win11 + Ubuntu-24.04
• superfile Version: v1.3.3

[lazysegtree]

@miguel-montes-lorenzo Have you updated your shell configs to add a function for spf command to enable cd_on_quit ? That is needed.

Check 'cd_on_quit' section in https://superfile.dev/configure/superfile-config/

[miguel-montes-lorenzo]

If I'm not wrong, the docs say to do this to activate cd_on_quit for the default quit (https://superfile.dev/configure/superfile-config/), not for the cd_quit hotkey (https://superfile.dev/configure/custom-hotkeys/). But yes, I added this to my .bashrc file:

spf() {
    os=$(uname -s)
    # Linux
    if [[ "$os" == "Linux" ]]; then
        export SPF_LAST_DIR="${XDG_STATE_HOME:-$HOME/.local/state}/superfile/lastdir"
    fi
    # macOS
    if [[ "$os" == "Darwin" ]]; then
        export SPF_LAST_DIR="$HOME/Library/Application Support/superfile/lastdir"
    fi
    command spf "$@"
    [ ! -f "$SPF_LAST_DIR" ] || {
        . "$SPF_LAST_DIR"
        rm -f -- "$SPF_LAST_DIR" > /dev/null
    }
}

[lazysegtree]

Sorry, the docs are inconsistent. This function is indeed needed for the key to work.

[lazysegtree]

Could you share debug logs?

• Make sure to set debug = true in the config file to enable debug logs
• Run spf path-list to see log location.

This is what I see in my logs

time=2025-10-04T22:54:27.956+05:30 level=DEBUG msg="model.Update() called" msgType=tea.KeyMsg
time=2025-10-04T22:54:27.956+05:30 level=DEBUG msg=model.handleKeyInput msg=Q typestr=runes runes=[81] type=-1 paste=false alt=false
time=2025-10-04T22:54:27.956+05:30 level=DEBUG msg="model.handleKeyInput. model info. " filePanelFocusIndex=0 filePanel.isFocused=true filePanel.panelMode=browserMode typingModal.open=false notifyModel.open=false promptModal.open=false fileModel.renaming=false searchBar.focussed=false helpMenu.open=false firstTextInput=false focusPanel=nonePanelFocus
time=2025-10-04T22:54:27.957+05:30 level=DEBUG msg="Quitting superfile" "current dir"=/Users/nitin/Programming/spf_forks/magic
time=2025-10-04T22:54:27.958+05:30 level=DEBUG msg="Submitting metadata fetch request" id=5 path=/Users/nitin/Programming/spf_forks/magic/.claude
time=2025-10-04T22:54:27.958+05:30 level=DEBUG msg="model.View() called" mainPanelHeight=20 footerHeight=7 fullHeight=31 fullWidth=126
time=2025-10-04T22:54:27.958+05:30 level=DEBUG msg="Rendering sidebar." cursor=0 renderIndex=0 "dirs count"=11 "sidebar focused"=false
time=2025-10-04T22:54:27.963+05:30 level=DEBUG msg="Render stats for main panel" sidebarLineCnt=22 sidebarMaxW=22 filePanelLineCnt=22 filePanelMaxW=54 filePreviewLineCnt=22 filePreviewMaxW=50
time=2025-10-04T22:54:27.964+05:30 level=DEBUG msg="Render stats for footer" processBarLineCnt=9 processBarMaxW=42 metaDataLineCnt=9 metaDataMaxW=42 clipboardBarLineCnt=9 clipboardBarMaxW=42
time=2025-10-04T22:54:27.965+05:30 level=DEBUG msg="model.View() called" mainPanelHeight=20 footerHeight=7 fullHeight=31 fullWidth=126
time=2025-10-04T22:54:27.965+05:30 level=DEBUG msg="Rendering sidebar." cursor=0 renderIndex=0 "dirs count"=11 "sidebar focused"=false
time=2025-10-04T22:54:27.970+05:30 level=DEBUG msg="Render stats for main panel" sidebarLineCnt=22 sidebarMaxW=22 filePanelLineCnt=22 filePanelMaxW=54 filePreviewLineCnt=22 filePreviewMaxW=50
time=2025-10-04T22:54:27.971+05:30 level=DEBUG msg="Render stats for footer" processBarLineCnt=9 processBarMaxW=42 metaDataLineCnt=9 metaDataMaxW=42 clipboardBarLineCnt=9 clipboardBarMaxW=42

[miguel-montes-lorenzo]

When I enter the following sequence of inputs:

> spf
> <right>  # to move into directory
> <g>  # my keybind to cd_quit (it is ignored)
> <q>  # to exit superfile normally

This is what I see:

time=2025-10-05T12:47:25.791+02:00 level=DEBUG msg="Runtime information" runtime.GOOS=linux
time=2025-10-05T12:47:25.791+02:00 level=DEBUG msg="Directory configuration" cwd=/home/username start_directories=[/home/username]
time=2025-10-05T12:47:25.791+02:00 level=DEBUG msg="Memory usage" alloc_bytes=2050016 total_alloc_bytes=5849136 heap_objects=7929 sys_bytes=12278800
time=2025-10-05T12:47:25.791+02:00 level=DEBUG msg="Object sizes" model_size_bytes=21400 filePanel_size_bytes=10576 sidebarModel_size_bytes=10416 renderer_size_bytes=480 borderConfig_size_bytes=88
time=2025-10-05T12:47:25.932+02:00 level=INFO msg="Successfully detected terminal cell size via ioctl" pixels_per_column=16 pixels_per_row=32
time=2025-10-05T12:47:25.932+02:00 level=INFO msg="Terminal cell size detection" pixels_per_column=16 pixels_per_row=32
time=2025-10-05T12:47:25.932+02:00 level=DEBUG msg="model.View() called" mainPanelHeight=0 footerHeight=0 fullHeight=0 fullWidth=0
time=2025-10-05T12:47:25.932+02:00 level=DEBUG msg="model.Update() called"
time=2025-10-05T12:47:25.933+02:00 level=DEBUG msg="Submitting metadata fetch request" id=0 path=/home/username/data
time=2025-10-05T12:47:25.934+02:00 level=DEBUG msg="model.View() called" mainPanelHeight=31 footerHeight=9 fullHeight=44 fullWidth=85
time=2025-10-05T12:47:25.934+02:00 level=DEBUG msg="Rendering sidebar." cursor=0 renderIndex=0 "dirs count"=7 "sidebar focused"=false
time=2025-10-05T12:47:25.937+02:00 level=DEBUG msg="Attempting to render preview" itemPath=/home/username/data mode=drwxr-xr-x isRegular=false
time=2025-10-05T12:47:25.940+02:00 level=DEBUG msg="model.Update() called"
time=2025-10-05T12:47:25.940+02:00 level=DEBUG msg="Message of type that is not handled" type=cursor.initialBlinkMsg
time=2025-10-05T12:47:25.941+02:00 level=DEBUG msg="Submitting metadata fetch request" id=1 path=/home/username/data
time=2025-10-05T12:47:25.941+02:00 level=DEBUG msg="model.View() called" mainPanelHeight=31 footerHeight=9 fullHeight=44 fullWidth=85
time=2025-10-05T12:47:25.941+02:00 level=DEBUG msg="Rendering sidebar." cursor=0 renderIndex=0 "dirs count"=7 "sidebar focused"=false
time=2025-10-05T12:47:25.946+02:00 level=DEBUG msg="Attempting to render preview" itemPath=/home/username/data mode=drwxr-xr-x isRegular=false
time=2025-10-05T12:47:25.948+02:00 level=DEBUG msg="model.Update() called"
time=2025-10-05T12:47:25.948+02:00 level=DEBUG msg="Message of type that is not handled" type=tea.setWindowTitleMsg
time=2025-10-05T12:47:25.949+02:00 level=DEBUG msg="Submitting metadata fetch request" id=2 path=/home/username/data
time=2025-10-05T12:47:25.949+02:00 level=DEBUG msg="model.View() called" mainPanelHeight=31 footerHeight=9 fullHeight=44 fullWidth=85
time=2025-10-05T12:47:25.949+02:00 level=DEBUG msg="Rendering sidebar." cursor=0 renderIndex=0 "dirs count"=7 "sidebar focused"=false
time=2025-10-05T12:47:25.952+02:00 level=DEBUG msg="Attempting to render preview" itemPath=/home/username/data mode=drwxr-xr-x isRegular=false
time=2025-10-05T12:47:25.954+02:00 level=DEBUG msg="model.Update() called"
time=2025-10-05T12:47:25.954+02:00 level=DEBUG msg="Got metadata message" id=0
time=2025-10-05T12:47:25.954+02:00 level=DEBUG msg="model.View() called" mainPanelHeight=31 footerHeight=9 fullHeight=44 fullWidth=85
time=2025-10-05T12:47:25.954+02:00 level=DEBUG msg="Rendering sidebar." cursor=0 renderIndex=0 "dirs count"=7 "sidebar focused"=false
time=2025-10-05T12:47:25.957+02:00 level=DEBUG msg="Attempting to render preview" itemPath=/home/username/data mode=drwxr-xr-x isRegular=false
time=2025-10-05T12:47:25.960+02:00 level=DEBUG msg="model.Update() called"
time=2025-10-05T12:47:25.960+02:00 level=DEBUG msg="Got metadata message" id=1
time=2025-10-05T12:47:25.960+02:00 level=DEBUG msg="model.View() called" mainPanelHeight=31 footerHeight=9 fullHeight=44 fullWidth=85
time=2025-10-05T12:47:25.960+02:00 level=DEBUG msg="Rendering sidebar." cursor=0 renderIndex=0 "dirs count"=7 "sidebar focused"=false
time=2025-10-05T12:47:25.962+02:00 level=DEBUG msg="Attempting to render preview" itemPath=/home/username/data mode=drwxr-xr-x isRegular=false
time=2025-10-05T12:47:25.964+02:00 level=DEBUG msg="model.Update() called"
time=2025-10-05T12:47:25.964+02:00 level=DEBUG msg="Got metadata message" id=2
time=2025-10-05T12:47:25.964+02:00 level=DEBUG msg="model.View() called" mainPanelHeight=31 footerHeight=9 fullHeight=44 fullWidth=85
time=2025-10-05T12:47:25.964+02:00 level=DEBUG msg="Rendering sidebar." cursor=0 renderIndex=0 "dirs count"=7 "sidebar focused"=false
time=2025-10-05T12:47:25.967+02:00 level=DEBUG msg="Attempting to render preview" itemPath=/home/username/data mode=drwxr-xr-x isRegular=false
time=2025-10-05T12:47:28.794+02:00 level=DEBUG msg="model.Update() called"
time=2025-10-05T12:47:28.794+02:00 level=DEBUG msg=model.handleKeyInput msg=right typestr=right runes=[] type=-4 paste=false alt=false
time=2025-10-05T12:47:28.794+02:00 level=DEBUG msg="model.handleKeyInput. model info. " filePanelFocusIndex=0 filePanel.focusType=focus filePanel.panelMode=browserMode typingModal.open=false warnModal.open=false promptModal.open=false fileModel.renaming=false searchBar.focussed=false helpMenu.open=false firstTextInput=false focusPanel=nonePanelFocus
time=2025-10-05T12:47:28.794+02:00 level=DEBUG msg=updateCurrentFilePanelDir panel.location=/home/username path=/home/username/data
time=2025-10-05T12:47:28.794+02:00 level=DEBUG msg="updateCurrentFilePanelDir : After update" cursor=0 render=0
time=2025-10-05T12:47:28.795+02:00 level=DEBUG msg="Submitting metadata fetch request" id=3 path=/home/username/data/mlops
time=2025-10-05T12:47:28.796+02:00 level=DEBUG msg="model.View() called" mainPanelHeight=31 footerHeight=9 fullHeight=44 fullWidth=85
time=2025-10-05T12:47:28.796+02:00 level=DEBUG msg="Rendering sidebar." cursor=0 renderIndex=0 "dirs count"=7 "sidebar focused"=false
time=2025-10-05T12:47:28.799+02:00 level=DEBUG msg="Attempting to render preview" itemPath=/home/username/data/mlops mode=drwxr-xr-x isRegular=false
time=2025-10-05T12:47:28.801+02:00 level=DEBUG msg="model.Update() called"
time=2025-10-05T12:47:28.801+02:00 level=DEBUG msg="Got metadata message" id=3
time=2025-10-05T12:47:28.801+02:00 level=DEBUG msg="model.View() called" mainPanelHeight=31 footerHeight=9 fullHeight=44 fullWidth=85
time=2025-10-05T12:47:28.801+02:00 level=DEBUG msg="Rendering sidebar." cursor=0 renderIndex=0 "dirs count"=7 "sidebar focused"=false
time=2025-10-05T12:47:28.804+02:00 level=DEBUG msg="Attempting to render preview" itemPath=/home/username/data/mlops mode=drwxr-xr-x isRegular=false
time=2025-10-05T12:47:30.548+02:00 level=DEBUG msg="model.Update() called"
time=2025-10-05T12:47:30.548+02:00 level=DEBUG msg=model.handleKeyInput msg=g typestr=runes runes=[103] type=-1 paste=false alt=false
time=2025-10-05T12:47:30.548+02:00 level=DEBUG msg="model.handleKeyInput. model info. " filePanelFocusIndex=0 filePanel.focusType=focus filePanel.panelMode=browserMode typingModal.open=false warnModal.open=false promptModal.open=false fileModel.renaming=false searchBar.focussed=false helpMenu.open=false firstTextInput=false focusPanel=nonePanelFocus
time=2025-10-05T12:47:30.549+02:00 level=DEBUG msg="Submitting metadata fetch request" id=4 path=/home/username/data/mlops
time=2025-10-05T12:47:30.549+02:00 level=DEBUG msg="model.View() called" mainPanelHeight=31 footerHeight=9 fullHeight=44 fullWidth=85
time=2025-10-05T12:47:30.549+02:00 level=DEBUG msg="Rendering sidebar." cursor=0 renderIndex=0 "dirs count"=7 "sidebar focused"=false
time=2025-10-05T12:47:30.552+02:00 level=DEBUG msg="Attempting to render preview" itemPath=/home/username/data/mlops mode=drwxr-xr-x isRegular=false
time=2025-10-05T12:47:30.556+02:00 level=DEBUG msg="model.Update() called"
time=2025-10-05T12:47:30.556+02:00 level=DEBUG msg="Got metadata message" id=4
time=2025-10-05T12:47:30.556+02:00 level=DEBUG msg="model.View() called" mainPanelHeight=31 footerHeight=9 fullHeight=44 fullWidth=85
time=2025-10-05T12:47:30.556+02:00 level=DEBUG msg="Rendering sidebar." cursor=0 renderIndex=0 "dirs count"=7 "sidebar focused"=false
time=2025-10-05T12:47:30.560+02:00 level=DEBUG msg="Attempting to render preview" itemPath=/home/username/data/mlops mode=drwxr-xr-x isRegular=false
time=2025-10-05T12:47:41.109+02:00 level=DEBUG msg="model.Update() called"
time=2025-10-05T12:47:41.109+02:00 level=DEBUG msg=model.handleKeyInput msg=q typestr=runes runes=[113] type=-1 paste=false alt=false
time=2025-10-05T12:47:41.109+02:00 level=DEBUG msg="model.handleKeyInput. model info. " filePanelFocusIndex=0 filePanel.focusType=focus filePanel.panelMode=browserMode typingModal.open=false warnModal.open=false promptModal.open=false fileModel.renaming=false searchBar.focussed=false helpMenu.open=false firstTextInput=false focusPanel=nonePanelFocus
time=2025-10-05T12:47:41.109+02:00 level=DEBUG msg="Quitting superfile" "current dir"=/home/username/data
time=2025-10-05T12:47:41.110+02:00 level=DEBUG msg="Submitting metadata fetch request" id=5 path=/home/username/data/mlops
time=2025-10-05T12:47:41.110+02:00 level=DEBUG msg="model.View() called" mainPanelHeight=31 footerHeight=9 fullHeight=44 fullWidth=85
time=2025-10-05T12:47:41.110+02:00 level=DEBUG msg="Rendering sidebar." cursor=0 renderIndex=0 "dirs count"=7 "sidebar focused"=false
time=2025-10-05T12:47:41.112+02:00 level=DEBUG msg="Attempting to render preview" itemPath=/home/username/data/mlops mode=drwxr-xr-x isRegular=false
time=2025-10-05T12:47:41.115+02:00 level=DEBUG msg="model.View() called" mainPanelHeight=31 footerHeight=9 fullHeight=44 fullWidth=85
time=2025-10-05T12:47:41.115+02:00 level=DEBUG msg="Rendering sidebar." cursor=0 renderIndex=0 "dirs count"=7 "sidebar focused"=false
time=2025-10-05T12:47:41.117+02:00 level=DEBUG msg="Attempting to render preview" itemPath=/home/username/data/mlops mode=drwxr-xr-x isRegular=false

It looks like the g input is being received:

time=2025-10-05T12:47:30.548+02:00 level=DEBUG msg=model.handleKeyInput msg=g typestr=runes runes=[103] type=-1 paste=false alt=false

Just doesn't do anything.

This is my full config.toml file:

# More details are at https://superfile.netlify.app/configure/superfile-config/
#
# change your theme
theme = 'ayu-dark'
# 
# The editor files will be opened with. (Leave blank to use the EDITOR environment variable).
editor = ""
# 
# The editor directories will be opened with. (Leave blank to use the default editors).
dir_editor = ""
#
# Auto check for update
auto_check_update = true
# 
# Cd on quit (For more details, please check out https://superfile.netlify.app/configure/superfile-config/#cd_on_quit)
cd_on_quit = false  # modified
#
# Whether to open file preview automatically every time superfile is opened.
default_open_file_preview = true
#
# Whether to show image preview
show_image_preview = true
# 
#
# Whether to hide additional footer info for file panel.
show_panel_footer_info = true
#
# The path of the first file panel when superfile is opened.
default_directory = "."
#
# Display file sizes using powers of 1000 (kB, MB, GB) instead of powers of 1024 (KiB, MiB, GiB).
file_size_use_si = false
#
# Default sort type (0: Name, 1: Size, 2: Date Modified, 3: Type).
default_sort_type = 0
#
# Default sort order (false: Ascending, true: Descending).
sort_order_reversed = false
#
# Case sensitive sort by name (upper "B" comes before lower "a" if true).
case_sensitive_sort = false
#
# Whether to exit the shell on successful command execution.
shell_close_on_success = false
#
# Whether to enable debug mode.
debug = true
#
# Whether to ignore warnings about missing fields in the config file.
ignore_missing_fields = false
#
# ================   Style =================
#
# Whether to use the builtin syntax highlighting with chroma or use bat. Values: "" for builtin chroma, "bat" for bat
code_previewer = ''
# 
# If you don't have or don't want Nerdfont installed you can turn this off
nerdfont = true
#
# Set transparent background or not (this only work when your terminal background is transparent)
transparent_background = false
# 
# File preview width allow '0' (this mean same as file panel),'x' x must be from 2 to 10 (This means that the width of the file preview will be one xth of the total width.)
file_preview_width = 0
#
# The length of the sidebar. If you don't want to display the sidebar, you can input 0 directly. If you want to display the value, please place it in the range of 3-20.
sidebar_width = 20
#
# Border style
# Make sure to add strings exactly one character wide. Use ' ' for borderless 
border_top = '─'
border_bottom = '─'
border_left = '│'
border_right = '│'
border_top_left = '╭'
border_top_right = '╮'
border_bottom_left = '╰'
border_bottom_right = '╯'
border_middle_left = '├'
border_middle_right = '┤'
# 
# ========== PLUGINS ========== #
# Plugins means that you need to install some external dependencies to use them.
# 
# Show more detailed metadata, please install exiftool before enabling this plugin!
metadata = false
#
# Enable MD5 checksum generation for files
enable_md5_checksum = false
#
# Zoxide support for the fast navigation
zoxide_support = false

This is my full hotkeys.toml file:

# =================================================================================================
# Global hotkeys (cannot conflict with other hotkeys)
confirm = ['enter', 'right', 'l']
quit = ['q', 'esc']

# movement
list_up = ['up', 'k']
list_down = ['down', 'j']
page_up = ['pgup','']
page_down = ['pgdown','']
# file panel control
create_new_file_panel = ['n', '']
close_file_panel = ['w', '']
next_file_panel = ['ctrl+right', 'L']
previous_file_panel = ['ctrl+left', 'H']
toggle_file_preview_panel = ['f', '']
open_sort_options_menu = ['o', '']
toggle_reverse_sort = ['R', '']
# change focus
focus_on_process_bar = ['p', '']
focus_on_sidebar = ['s', '']
focus_on_metadata = ['m', '']
# create file/directory and rename
file_panel_item_create = ['ctrl+n', '']
file_panel_item_rename = ['ctrl+r', '']
# file operations
copy_items = ['ctrl+c', '']
cut_items = ['ctrl+x', '']
paste_items = ['ctrl+v', 'ctrl+w', '']
delete_items = ['ctrl+d', 'delete', '']
# compress and extract
extract_file = ['ctrl+e', '']
compress_file = ['ctrl+a', '']
# editor
open_file_with_editor = ['e', '']
open_current_directory_with_editor = ['E', '']
# other
pinned_directory = ['P', '']
toggle_dot_file = ['.', '']
change_panel_mode = ['v', '']
open_help_menu = ['?', '']
open_command_line = [':', '']
open_spf_prompt = ['>', '']
copy_path = ['ctrl+p', '']
copy_present_working_directory = ['c', '']
toggle_footer = ['F', '']
# =================================================================================================
# Typing hotkeys (can conflict with all hotkeys)
confirm_typing = ['enter', '']
cancel_typing = ['ctrl+c', 'esc']
# =================================================================================================
# Normal mode hotkeys (can conflict with other modes, cannot conflict with global hotkeys)
parent_directory = ['h', 'left', 'backspace']
search_bar = ['/', '']
# =================================================================================================
# Select mode hotkeys (can conflict with other modes, cannot conflict with global hotkeys)
file_panel_select_mode_items_select_down = ['shift+down', 'J']
file_panel_select_mode_items_select_up = ['shift+up', 'K']
file_panel_select_all_items = ['A', '']

# ========== CUSTOM ========== #
cd_quit = ['Q', 'g']   # quit and cd (was 'Q' by default)

This is what I have in my .bashrc:

### superfile [file explorer]
spf() {
    os=$(uname -s)
    # Linux
    if [[ "$os" == "Linux" ]]; then
        export SPF_LAST_DIR="${XDG_STATE_HOME:-$HOME/.local/state}/superfile/lastdir"
    fi
    # macOS
    if [[ "$os" == "Darwin" ]]; then
        export SPF_LAST_DIR="$HOME/Library/Application Support/superfile/lastdir"
    fi
    command spf "$@"
    [ ! -f "$SPF_LAST_DIR" ] || {
        . "$SPF_LAST_DIR"
        rm -f -- "$SPF_LAST_DIR" > /dev/null
    }
}

And here is some system info:

echo "User: $USER"                                                                                                                                              13:16
echo "Host: $(hostname)"
echo "OS: $(lsb_release -d | cut -f2)"
echo "Kernel: $(uname -r)"
echo "Arch: $(uname -m)"
echo "Shell: $SHELL"
echo "Uptime: $(uptime -p)"

User: username
Host: AsusUser
OS: Ubuntu 24.04.3 LTS
Kernel: 5.15.133.1-microsoft-standard-WSL2
Arch: x86_64
Shell: /bin/bash
Uptime: up 2 hours, 48 minutes

[lazysegtree]

@miguel-montes-lorenzo Ohh. I am so sorry. I just remembered that the feature is not yet released (-_-)

[lazysegtree]

#923

[lazysegtree]

Either try https://github.com/yorukot/superfile/releases/tag/v1.4.0-rc2

Or you can wait for 1.4.0 release