Package: consult

Defined variables (80)

consult-bookmark-narrowBookmark narrowing configuration.
consult-narrow-keyPrefix key for narrowing during completion.
consult-source-hidden-bufferHidden buffer source for `consult-buffer'.
consult-find-argsCommand line arguments for find, see `consult-find'.
consult-fontify-preservePreserve fontification for line-based commands.
consult-mode-command-filterFilter commands for `consult-mode-command'.
consult--buffer-displayBuffer display function.
consult--narrow-configNarrowing config of the current completion.
consult-preview-partial-sizeFiles larger than this byte limit are previewed partially.
consult-after-jump-hookFunction called after jumping to a location.
consult--gc-percentageLarge GC percentage for temporary increase.
consult-preview-partial-chunkPartial preview chunk size in bytes.
consult-preview-max-countNumber of file buffers to keep open temporarily during preview.
consult-source-file-registerFile register source.
consult--gc-thresholdLarge GC threshold for temporary increase.
consult-source-buffer-registerBuffer register source.
consult-mode-historiesAlist of mode histories (mode history index bol).
consult-project-buffer-sourcesSources used by `consult-project-buffer'.
consult-source-project-bufferProject buffer source for `consult-buffer'.
consult-git-grep-argsCommand line arguments for git-grep, see `consult-git-grep'.
consult-man-argsCommand line arguments for man, see `consult-man'.
consult-source-bookmarkBookmark source for `consult-buffer'.
consult-line-start-from-topStart search from the top if non-nil.
consult--process-chunkIncrease process output chunk size.
consult--customize-alistCommand configuration alist for fine-grained configuration.
consult-async-min-inputMinimum number of characters needed, before asynchronous process is called.
consult--tofu-charSpecial character used to encode line suffixes for disambiguation.
consult-ripgrep-argsCommand line arguments for ripgrep, see `consult-ripgrep'.
consult--tofu-regexpSpecial character regexp.
consult-widen-keyKey used for widening during completion.
consult-preview-excluded-buffersBuffers excluded from preview.
consult-source-project-recent-file-hiddenLike `consult-source-project-recent-file' but hidden by default.
consult--completion-refresh-hookRefresh completion system.
consult--completion-candidate-hookGet candidate from completion system.
consult-buffer-list-functionList of buffers to use for selection.
consult-isearch-history-mapAdditional keymap used by `consult-isearch-history'.
consult-narrow-mapNarrowing keymap which is added to the local minibuffer map.
consult--regexp-compilerRegular expression compiler used by `consult-grep' and other commands.
consult-source-project-rootKnown project root source.
consult-preview-variablesVariables which are bound for file preview.
consult-async-indicatorAsync indicator characters and faces.
consult--focus-lines-overlaysOverlays used by `consult-focus-lines'.
consult-project-functionFunction which returns project root directory.
consult-themesList of themes (symbols or regexps) to be presented for selection.
consult--async-logBuffer for async logging output used by `consult--async-process'.
consult--preview-functionMinibuffer-local variable which exposes the current preview function.
consult-source-project-root-hiddenLike `consult-source-project-root' but hidden by default.
consult-line-numbers-widenShow absolute line numbers when narrowing is active.
consult-source-other-bufferSource for `consult-buffer' for buffers from other frames or tabs.
consult-async-mapKeymap added for commands with asynchronous candidates.
consult-fd-argsCommand line arguments for fd, see `consult-fd'.
consult-preview-allowed-hooksList of hooks, which should be executed during file preview.
consult-async-split-styleAsync splitting style, see `consult-async-split-styles-alist'.
consult--narrowCurrent narrow key.
consult-grep-argsCommand line arguments for grep, see `consult-grep'.
consult--annotate-align-widthMaximum candidate width used for annotation alignment.
consult-async-input-debounceInput debounce for asynchronous commands.
consult-async-refresh-delayRefreshing delay of the completion UI for asynchronous commands.
consult-fontify-max-sizeAvoid whole-buffer fontification for buffers larger than this character limit.
consult--annotate-align-stepRound candidate width.
consult--tofu-rangeSpecial character range.
consult-source-project-buffer-hiddenLike `consult-source-project-buffer' but hidden by default.
consult--convert-regexp-tableRegexp conversion table.
consult-grep-max-columnsMaximal number of columns of grep output.
consult--focus-lines-indicatorMode line indicator displayed if `consult-focus-lines' is active.
consult-source-bufferBuffer source for `consult-buffer'.
consult-source-recent-fileRecent file source for `consult-buffer'.
consult-locate-argsCommand line arguments for locate, see `consult-locate'.
consult-goto-line-numbersShow line numbers for `consult-goto-line'.
consult-async-input-throttleInput throttle for asynchronous commands.
consult-preview-keyPreview trigger keys, can be nil, `any', a single key or a list of keys.
consult-source-modified-bufferModified buffer source for `consult-buffer'.
consult--narrow-overlayNarrowing indicator overlay.
consult-async-split-styles-alistAsync splitting styles.
consult-preview-excluded-filesList of regexps matched against names of files, which are not previewed.
consult--grep-match-regexpRegexp used to match file and line of grep output.
consult-buffer-sourcesSources used by `consult-buffer'.
consult-point-placementWhere to leave point when jumping to a match.
consult-source-project-recent-fileProject file source for `consult-buffer'.
consult-buffer-filterFilter regexps for `consult-buffer'.

Defined functions (258)

consult-register--candidates(&optional PRED)
consult-compile-error(&optional ARG GREP)
consult--in-region(START END TABLE PREDICATE)
consult--left-truncate-file(FILE)
consult-man(&optional INITIAL)
consult--frame-buffer-list()
consult-grep(&optional DIR INITIAL)
consult--multi-static(SOURCES)
consult--grep-lookahead-p(&rest CMD)
consult--completion-table-in-buffer(TABLE &optional BUFFER)
consult--bookmark-action(BM)
consult--buffer-state()
consult-outline(&optional LEVEL)
consult--async-dynamic(FUN &optional RESTART)
consult--line-multi-candidates(BUFFERS INPUT CALLBACK)
consult--async-min-input(&optional MIN-INPUT)
consult--buffer-action(BUFFER &optional NORECORD)
consult--grep-exclude-args()
consult--async-map(FUN)
consult--fast-abbreviate-file-name(NAME)
consult--location-candidate(CAND MARKER LINE TOFU &rest PROPS)
consult--in-buffer(FUN &optional BUFFER)
consult--highlight-regexps(REGEXPS IGNORE-CASE STR)
consult--with-preview-f(PREVIEW-KEY STATE TRANSFORM CANDIDATE SAVE-INPUT BODY)
consult--project-name(DIR)
consult--multi-async-predicate(SOURCES CAND)
consult--local-let(BINDS &rest BODY)
consult--split-perl(STR &optional PLIST)
consult--line-match(SELECTED CANDIDATES INPUT &rest _)
consult--line-multi-match(SELECTED CANDIDATES &rest _)
consult--project-root(&optional MAY-PROMPT)
consult--project-known-roots()
consult-minor-mode-menu()
consult--locate-builder(INPUT)
consult--original-window()
consult--bookmark-preview()
consult--jump-state()
consult--async-predicate(PRED)
consult--man-builder(INPUT)
consult-customize(&rest ARGS)
consult--preview-add-buffer(LIST BUF &optional NAME)
consult--build-args(ARG)
consult--string-hash(STRINGS)
consult--completion-filter-dispatch(PATTERN CANDS CATEGORY HIGHLIGHT)
consult--with-async-f(ASYNC BODY)
consult--widen-key()
consult--async-wrap(ASYNC)
consult--multi-lookup(SOURCES SELECTED CANDIDATES &rest _)
consult--find(PROMPT BUILDER INITIAL)
consult--annotate-align(CAND ANN)
consult--temporary-files()
consult--preview-rename-buffer(BUF &optional NAME)
consult--async-process(BUILDER &rest PROPS)
consult--current-history()
consult--insertion-preview(START END)
consult-yank-pop(&optional ARG)
consult--man-state()
consult--slow-operation(MESSAGE &rest BODY)
consult--outline-candidates()
consult-find(&optional DIR INITIAL)
consult--lookup-prop(PROP SELECTED CANDIDATES &rest _)
consult--buffer-sort-alpha(BUFFERS)
consult--read-from-kill-ring()
consult--async-split(&optional STYLE)
consult-mark(&optional MARKERS)
consult--marker-from-line-column(BUFFER LINE COLUMN)
consult--completion-filter(PATTERN CANDS CATEGORY HIGHLIGHT)
consult--customize-put(CMDS PROP FORM)
consult--buffer-preview()
consult--file-action(FILE)
consult--read-affixate(FUN CANDS)
consult-isearch-forward(&optional REVERSE)
consult-theme(THEME)
consult--type-narrow(TYPES)
consult--tofu-append(CAND ID)
consult--grep-make-builder(PATHS)
consult--make-overlay(BEG END &rest PROPS)
consult-locate(&optional INITIAL)
consult--with-increased-gc(&rest BODY)
consult--mode-command-candidates(MODES)
consult--grep-position(CAND &optional FIND-FILE)
consult-completion-in-region(START END TABLE PREDICATE)
consult--jump(POS)
consult--async-highlight(&optional HIGHLIGHT)
consult-fd(&optional DIR INITIAL)
consult--filter-find-file-hook(ORIG &rest HOOKS)
consult--valid-regexp-p(RE)
consult--forbid-minibuffer()
consult--goto-line-position(STR)
consult--join-regexps(REGEXPS TYPE)
consult--mark-candidates(MARKERS)
consult--global-mark-candidates(MARKERS)
consult-grep-match(&optional ARG)
consult--count-lines(POS)
consult--async-pipeline(&rest ASYNC)
consult--buffer-sort-visibility(BUFFERS)
consult--setup-keymap(KEYMAP ASYNC NARROW PREVIEW-KEY)
consult--focus-lines-revert()
consult--with-project(&rest BODY)
consult--multi-async(SOURCES)
consult--async-merge-sink(SINK INDICATOR TAIL IDX)
consult--line-with-mark(MARKER)
consult--keep-lines-state(FILTER)
consult--require-minibuffer()
consult--find-file-temporarily-1(NAME)
consult--location-state(CANDIDATES)
consult--async-options()
consult--line-multi-group(CAND TRANSFORM)
consult--grep(PROMPT MAKE-BUILDER DIR INITIAL)
consult--async-throttle(&optional THROTTLE DEBOUNCE)
consult--get-location(CAND)
consult--jump-preview()
consult-isearch-history()
consult--preview-key-debounce(PREVIEW-KEY CAND)
consult-recent-file()
consult-mode-command(&rest MODES)
consult--default-regexp-compiler(INPUT TYPE IGNORE-CASE)
consult--man-format(LINES)
consult--multi-group(SOURCES CAND TRANSFORM)
consult--default-completion-list-refresh()
consult--grep-format(BUILDER)
consult--read
consult--read-1
consult--highlight-literals(LITERALS IGNORE-CASE STR)
consult--vertico-refresh()
consult--file-preview()
consult--with-preview(PREVIEW-KEY STATE TRANSFORM CANDIDATE SAVE-INPUT &rest BODY)
consult--remove-dups(LIST)
consult--display-width(STRING)
consult--buffer-query
consult--vertico-candidate()
consult--multi-narrow(SOURCES)
consult--invisible-open-temporarily()
consult--each-line(BEG END &rest BODY)
consult--point-placement(STR START &rest IGNORED-FACES)
consult--buffer-file-hash()
consult--add-history(ASYNC ITEMS)
consult--lookup-cdr(SELECTED CANDIDATES &rest _)
consult-buffer-other-frame()
consult--buffer-pair(BUFFER)
consult--default-completion-minibuffer-candidate()
consult--customize-args(OPTIONS &rest DEFAULTS)
consult--with-increased-gc-f(FUN)
consult--invisible-open-permanently()
consult--tofu-strip(STR)
consult--async-log(FORMATTED &rest ARGS)
consult--lookup-candidate(SELECTED CANDIDATES &rest _)
consult--buffer-sort-alpha-current(BUFFERS)
consult--in-range-p(POS)
consult--async-indicator()
consult--compile-regexp(INPUT TYPE IGNORE-CASE)
consult--line-candidates(TOP CURR-LINE)
consult-history(&optional HISTORY INDEX BOL)
consult--with-project-f(FUN)
consult--regexp-filter(REGEXPS)
consult--tofu-p(CHAR)
consult-ripgrep(&optional DIR INITIAL)
consult-focus-lines(FILTER &optional SHOW INITIAL)
consult--tofu-get(CAND)
consult-narrow-help()
consult-global-mark(&optional MARKERS)
consult--jump-ensure-buffer(POS)
consult--format-file-line-match(FILE LINE MATCH)
consult--narrow-setup(CONFIG MAP)
consult--split-setup(SPLIT)
consult-git-grep(&optional DIR INITIAL)
consult--prompt
consult-line-multi(QUERY &optional INITIAL)
consult--file-register-p(REG)
consult-yank-replace(STRING)
consult--icomplete-refresh()
consult--async-sink()
consult--prefix-group(CAND TRANSFORM)
consult--directory-prompt(PROMPT DIR)
consult-buffer-other-window()
consult-goto-line(&optional ARG)
consult--bookmark-state()
consult--bookmark-candidates()
consult--find-highlights(STR START &rest IGNORED-FACES)
consult--copy-faces(BEG END STR)
consult--copy-property(BEG END STR PROP)
consult--isearch-history-candidates()
consult--prompt-1
consult--minor-mode-candidates()
consult--split-separator(STR PLIST)
consult--key-parse(KEY)
consult--man-action(PAGE &optional NODISPLAY)
consult--async-filter(FUN)
consult--mode-name(MODE)
consult--plist-remove(KEYS PLIST)
consult--tofu-encode(N)
consult--async-transform-by-input(FUN)
consult--preview-allowed-p(FUN)
consult--preview-append-local-pch(FUN)
consult--buffer-query-prompt(PROMPT QUERY)
consult--lookup-cons(SELECTED CANDIDATES &rest _)
consult-isearch-backward(&optional REVERSE)
consult--process-collection
consult--fd-make-builder(PATHS)
consult--lookup-location(SELECTED CANDIDATES &rest _)
consult--convert-regexp(REGEXP TYPE)
consult--async-refresh(&optional DELAY)
consult--buffer-register-p(REG)
consult--man-preview()
consult--split-none(STR &optional PLIST)
consult--completion-filter-complement(PATTERN CANDS CATEGORY)
consult--define-state(TYPE)
consult--multi-visible-p(SRC)
consult--async-debug(PREFIX)
consult-keep-lines(FILTER &optional INITIAL)
consult--multi-items(SRC)
consult--minibuffer-message(&rest MSG)
consult--grep-state()
consult--lookup-member(SELECTED CANDIDATES &rest _)
consult--default-completion-list-preview-setup()
consult-buffer-other-tab()
consult--default-completion-list-candidate()
consult--async-transform(FUN)
consult--state-with-return(STATE RETURN)
consult-project-buffer()
consult--join-regexps-permutations(REGEXPS ESC)
consult--split-escaped(STR)
consult--buffer-substring(BEG END &optional FONTIFY)
consult--tofu-hide-in-minibuffer(&rest _)
consult--type-group(TYPES)
consult--keep!(LIST FORM)
consult--ripgrep-make-builder(PATHS)
consult--multi-preview-key(SOURCES)
consult--multi-format(IDX SRC ITEMS)
consult--default-completion-list-preview()
consult--find-file-temporarily(NAME)
consult-narrow(KEY)
consult--focus-lines-state(FILTER)
consult--multi(SOURCES &rest OPTIONS)
consult--command-split(STR)
consult--find-make-builder(PATHS)
consult--dynamic-collection
consult--multi-annotate(SOURCES CAND)
consult--default-project-function(MAY-PROMPT)
consult-line(&optional INITIAL START)
consult--normalize-directory(DIR)
consult--file-state()
consult--multi-enabled-sources(SOURCES)
consult-yank-from-kill-ring(STRING &optional ARG)
consult--line-fontify(&optional CURR-LINE)
consult--git-grep-make-builder(PATHS)
consult-complex-command()
consult--async-p(FUN)
consult--async-static(ITEMS)
consult--line-point-placement(SELECTED CANDIDATES HIGHLIGHTED &rest IGNORED-FACES)
consult--preview-key-normalize(PREVIEW-KEY)
consult--multi-source(SOURCES CAND)
consult--group-prop(CAND TRANSFORM)
consult--async-merge(ASYNCS)
consult--with-async(ASYNC &rest BODY)
consult--multi-state(SOURCES)
consult--fontify-region(START END)
consult--completion-window-p()

Defined faces (20)

consult-highlight-matchFace used to highlight matches in the completion candidates. Used for example by `consult-grep'.
consult-bufferFace used to highlight buffers in `consult-buffer'.
consult-line-number-prefixFace used to highlight line number prefixes.
consult-narrow-indicatorFace used for the narrowing indicator.
consult-preview-lineFace used for line previews.
consult-fileFace used to highlight files in `consult-buffer'.
consult-async-optionFace used to highlight asynchronous command options.
consult-line-numberFace used to highlight location line in `consult-global-mark'.
consult-bookmarkFace used to highlight bookmarks in `consult-buffer'.
consult-async-finishedFace used if asynchronous process has finished.
consult-line-number-wrappedFace used to highlight line number prefixes after wrap around.
consult-highlight-markFace used for mark positions in completion candidates. Used for example by `consult-mark'. The face should be different than the `cursor' face to avoid confusion.
consult-grep-contextFace used to highlight grep context in `consult-grep'.
consult-helpFace used to highlight help, e.g., in `consult-register-store'.
consult-async-failedFace used if asynchronous process has failed.
consult-keyFace used to highlight keys, e.g., in `consult-register'.
consult-preview-matchFace used for match previews, e.g., in `consult-line'.
consult-preview-insertionFace used for previews of text to be inserted. Used by `consult-completion-in-region', `consult-yank' and `consult-history'.
consult-async-splitFace used to highlight punctuation character.
consult-async-runningFace used if asynchronous process is running.