Skip to content

Configuration

Configuration file location: $XDG_CONFIG_HOME/bookmark/config.toml

Most likely ~/.config/bookmark/config.toml

Configuration Options

The following options can be set in your configuration file:

General Settings

OptionTypeDefaultDescription
editorstringnvimEditor to use for editing bookmarks and config files
interactive_defaultboolfalseStart in interactive mode by default when no arguments are provided

Bookmark Settings

OptionTypeDefaultDescription
bookmark_locationstring~/.bookmarksDirectory where bookmark files are stored
navigation_toolstringcdTool to use for navigation. Options: cd, z, zoxide, none
shellstringauto-detectedShell type. Options: bash, zsh, fish, nu

Auto-Alias Generation

OptionTypeDefaultDescription
auto_alias_separatorstring""Character between first letters in auto-generated aliases. Empty = mcp, - = m-c-p
auto_alias_lowercasebooltrueConvert auto-generated aliases to lowercase

Display Settings

OptionTypeDefaultDescription
home_iconstring~Icon to represent home directory in list view (can be nerd font icon)
default_sort_bystringnewestDefault sort order. Options: newest, oldest, a-z, z-a
list_spacingstringspaceList item spacing. Options: compact (title only), tight (title + description, no margin), space (default, with spacing)

Function Aliases

OptionTypeDefaultDescription
function_aliasstringtrueEnable function wrapper that auto-sources bookmarks after running bookmark commands. Options: true (use default name “bookmark”), custom_name (use custom function name), false (disabled)
interactive_aliasstringbmAlias for interactive bookmark navigation. The function displays the TUI and executes the selected bookmark command. Options: bm (default), custom_name (use custom function name), false (disabled)

Colors

Colors support named, numeric, or hex values (e.g., 7, 13, "#ff8800").

OptionTypeDefaultDescription
headingsstring15Color for headings
primarystring02Primary color
secondarystring06Secondary color
textstring07Text color
text_highlightstring06Highlighted text color
description_highlightstring05Highlighted description color
tagsstring13Tags color
flagsstring12Flags color
mutedstring08Muted text color
accentstring13Accent color
borderstring08Border color

Example Configuration

# General
editor = "nvim"
interactive_default = false
# Bookmark settings
bookmark_location = "~/.bookmarks"
navigation_tool = "cd"
shell = "bash"
# Auto-alias generation
auto_alias_separator = ""
auto_alias_lowercase = true
# Display
home_icon = "~"
default_sort_by = "newest"
# Function aliases
function_alias = "true"
interactive_alias = "bm"
# UI
list_spacing = "space"
# Colors (numeric or hex values)
headings = "15"
primary = "02"
secondary = "06"
text = "07"
text_highlight = "06"
description_highlight = "05"
tags = "13"
flags = "12"
muted = "08"
border = "08"

Initializing Configuration

To create a new configuration file with default values:

Terminal window
bookmark config init

To overwrite an existing configuration:

Terminal window
bookmark config init --force

To create and immediately open in your editor:

Terminal window
bookmark config init --editor

Editing Configuration

To edit your configuration file:

Terminal window
bookmark config

This will open the config file in your configured editor.

See Also