aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorBozhidar Batsov <bozhidar@batsov.com>2020-12-02 11:15:15 +0200
committerBozhidar Batsov <bozhidar@batsov.com>2020-12-02 11:15:15 +0200
commit97bb7a97e95ad8f289447f217a4d8015257e4dcb (patch)
treef9fd1a266269d09921295ec48b40040f48f85939 /doc
parentfcc8b9081d523f88b5705ef220ebcc3b1d7360f6 (diff)
[Doc] Add projectile-commander to the list of potential switch project
commands
Diffstat (limited to 'doc')
-rw-r--r--doc/modules/ROOT/pages/configuration.adoc65
1 files changed, 64 insertions, 1 deletions
diff --git a/doc/modules/ROOT/pages/configuration.adoc b/doc/modules/ROOT/pages/configuration.adoc
index 7f8ae24..9676c82 100644
--- a/doc/modules/ROOT/pages/configuration.adoc
+++ b/doc/modules/ROOT/pages/configuration.adoc
@@ -231,13 +231,76 @@ may prefer to alter the value of `projectile-switch-project-action`:
=== `projectile-find-file`
-This is the default. With this setting, once you have selected your
+NOTE: This is the default.
+
+With this setting, once you have selected your
project via Projectile's completion system (see below), you will
remain in the completion system to select a file to visit. `projectile-find-file`
is capable of retrieving files in all sub-projects under the project root,
such as Git submodules. Currently, only Git is supported. Support for other VCS
will be added in the future.
+=== `projectile-commander`
+
+NOTE: This is the recommended option for people who find themselves often needing
+to invoke a different action on project switch.
+
+With this setting, after selecting a project to switch to, you'll be prompted to specify the action to take with a 1-character mnemonic.
+
+|===
+| Keybinding | Description
+| kbd:[?]
+| Commander help buffer.
+
+| kbd:[D]
+| Open project root in dired.
+
+| kbd:[R]
+| Regenerate the project's [e|g]tags.
+
+| kbd:[T]
+| Find test file in project.
+
+| kbd:[V]
+| Browse dirty projects
+
+| kbd:[a]
+| Run ag on project.
+
+| kbd:[b]
+| Switch to project buffer.
+
+| kbd:[d]
+| Find directory in project.
+
+| kbd:[e]
+| Find recently visited file in project.
+
+| kbd:[f]
+| Find file in project.
+
+| kbd:[g]
+| Run grep on project.
+
+| kbd:[j]
+| Find tag in project.
+
+| kbd:[k]
+| Kill all project buffers.
+
+| kbd:[o]
+| Run multi-occur on project buffers.
+
+| kbd:[r]
+| Replace a string in the project.
+
+| kbd:[s]
+| Switch project.
+
+| kbd:[v]
+| Open project root in vc-dir or magit.
+|===
+
=== `projectile-find-file-in-known-projects`
Similar to `projectile-find-file` but lists all files in all known projects. Since