Bug reports

If you find a bug or suspect that there is a problem with Consult, please carry out the following steps:

Search through the issue tracker if your issue has been reported before (and has been resolved eventually) in the meantime.
Remove all packages involved in the suspected bug from your installation.
Reinstall the newest version of all relevant packages. Updating alone is not sufficient, since package.el sometimes causes miscompilation. The list of packages includes Consult, Compat, Vertico or other completion UIs, Marginalia, Embark and Orderless.
Either use the default completion UI or ensure that exactly one of ‘vertico-mode’, ‘mct-mode’, or ‘icomplete-mode’ is enabled. The unsupported modes ‘selectrum-mode’, ‘ivy-mode’, ‘helm-mode’, ‘ido-mode’ and ‘ido-ubiquitous-mode’ must be disabled.
Ensure that the ‘completion-styles’ variable is properly configured. Try to set ‘completion-styles’ to a list including ‘substring’ or ‘orderless’.
Try to reproduce the issue with the newest stable Emacs version. Start a bare bone Emacs instance with ‘emacs -Q’ on the command line. Execute the following minimal code snippets in the scratch buffer. This way we can exclude side effects due to configuration settings. If other packages are relevant to reproduce the issue, include them in the minimal configuration snippet.

Minimal setup with Vertico for ‘emacs -Q’:

emacs-lisp

(package-initialize)
(require 'consult)
(require 'vertico)
(vertico-mode)
(setq completion-styles '(substring basic))

Minimal setup with the default completion system for ‘emacs -Q’:

emacs-lisp

(package-initialize)
(require 'consult)
(setq completion-styles '(substring basic))

Please provide the necessary important information with your bug report:

The minimal configuration snippet used to reproduce the issue.
Your completion UI (Default completion, Vertico, Mct or Icomplete).
A stack trace in case the bug triggers an exception.
Your Emacs version, since bugs may be fixed or introduced in newer versions.
Your operating system, since Emacs behavior varies subtly between Linux, Mac and Windows.
The package manager, e.g., straight.el or package.el, used to install the Emacs packages, in order to exclude update issues. Did you install Consult as part of the Doom Emacs distribution?
Do you use Evil? Consult does not provide Evil integration out of the box, but there is some support in evil-collection.

When evaluating Consult-related code snippets you should enable lexical binding. Consult relies on lambdas and lexical closures.

Bug reports ​