Function: projectile-doctor

projectile-doctor is an autoloaded, interactive and byte-compiled function defined in projectile.el.

Signature

(projectile-doctor)

Documentation

Diagnose Projectile's view of the current project.

Open a read-only report describing the project Projectile sees around default-directory: its root and which of projectile-project-root-functions found it, the detected project type and the marker that matched, the indexing method and the very command that will be run, which external tools are available, the file count and the cache state, the ignore rules in effect, and a list of findings - things that look fine and things worth changing. Outside a project the report says so and explains how to mark the directory as one.

The report is plain text, meant to be pasted into a bug report.

The doctor doesn't change what it measures: it never populates and never invalidates the file cache. A project that isn't cached yet is indexed with caching switched off and that run is reported as a fresh index. On remote projects indexing and program lookups are skipped rather than risking a hang, and the report says so.

Key Bindings

Source Code

;; Defined in ~/.emacs.d/elpa/projectile-20260820.1509/projectile.el
;;;###autoload
(defun projectile-doctor ()
  "Diagnose Projectile's view of the current project.

Open a read-only report describing the project Projectile sees around
`default-directory': its root and which of
`projectile-project-root-functions' found it, the detected project type
and the marker that matched, the indexing method and the very command
that will be run, which external tools are available, the file count and
the cache state, the ignore rules in effect, and a list of findings -
things that look fine and things worth changing.  Outside a project the
report says so and explains how to mark the directory as one.

The report is plain text, meant to be pasted into a bug report.

The doctor doesn't change what it measures: it never populates and never
invalidates the file cache.  A project that isn't cached yet is indexed
with caching switched off and that run is reported as a fresh index.  On
remote projects indexing and program lookups are skipped rather than
risking a hang, and the report says so."
  (interactive)
  (pop-to-buffer (projectile-doctor--report default-directory)))