Skip to content

Custom variables

TIP: If you have Marginalia installed, type ‘M-x customize-variable RET ^consult’ to see all Consult-specific customizable variables with their current values and abbreviated description. Alternatively, type ‘C-h a ^consult’ to get an overview of all Consult variables and functions with their descriptions.

VariableDescription
consult-after-jump-hookFunctions to call after jumping to a location
consult-async-input-debounceInput debounce for asynchronous commands
consult-async-input-throttleInput throttle for asynchronous commands
consult-async-min-inputMinimum numbers of input characters
consult-async-refresh-delayRefresh delay for asynchronous commands
consult-async-split-styleSplitting style used for async commands
consult-async-split-styles-alistAvailable splitting styles used for async commands
consult-async-indicatorAsync indicator characters
consult-bookmark-narrowNarrowing configuration for ‘consult-bookmark
consult-buffer-filterFilter for ‘consult-buffer
consult-buffer-list-functionFunction to retrieve list of buffers
consult-buffer-sourcesList of virtual buffer sources
consult-fd-argsCommand line arguments for fd
consult-find-argsCommand line arguments for find
consult-fontify-max-sizeBuffers larger than this limit are not fontified
consult-fontify-preservePreserve fontification for line-based commands.
consult-git-grep-argsCommand line arguments for git-grep
consult-goto-line-numbersShow line numbers for ‘consult-goto-line
consult-grep-max-columnsMaximal number of columns of the matching lines
consult-grep-argsCommand line arguments for grep
consult-imenu-configMode-specific configuration for ‘consult-imenu
consult-line-numbers-widenShow absolute line numbers when narrowing is active
consult-line-start-from-topStart the ‘consult-line’ search from the top
consult-locate-argsCommand line arguments for locate
consult-man-argsCommand line arguments for man
consult-mode-command-filterFilter for ‘consult-mode-command
consult-mode-historiesMode-specific history variables
consult-narrow-keyNarrowing prefix key during completion
consult-point-placementPlacement of the point when jumping to matches
consult-preview-keyKeys which triggers preview
consult-preview-allowed-hooksList of hooks to allow during preview
consult-preview-excluded-buffersPredicate to exclude buffers from preview
consult-preview-excluded-filesRegexps matched against file names during preview
consult-preview-max-countMaximum number of files to keep open during preview
consult-preview-partial-sizeFiles larger than this size are previewed partially
consult-preview-partial-chunkSize of the file chunk which is previewed partially
consult-preview-variablesAlist of variables to bind during preview
consult-project-buffer-sourcesList of virtual project buffer sources
consult-project-functionFunction which returns current project root
consult-register-prefixPrefix string for register keys during completion
consult-ripgrep-argsCommand line arguments for ripgrep
consult-themesList of themes to be presented for selection
consult-widen-keyWidening key during completion