diff options
| author | Bozhidar Batsov <bozhidar@batsov.com> | 2020-12-02 11:23:07 +0200 |
|---|---|---|
| committer | Bozhidar Batsov <bozhidar@batsov.com> | 2020-12-02 11:23:07 +0200 |
| commit | 40b9ca0452eb354dd1b0f45f46564a49faae001e (patch) | |
| tree | 82bbc6ad32729fe06ea32ecbe980e17c399d03e6 /doc | |
| parent | 97bb7a97e95ad8f289447f217a4d8015257e4dcb (diff) | |
[Docs] Document more prominently projectile-commander
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/modules/ROOT/pages/usage.adoc | 64 |
1 files changed, 64 insertions, 0 deletions
diff --git a/doc/modules/ROOT/pages/usage.adoc b/doc/modules/ROOT/pages/usage.adoc index 6148d0d..49c206a 100644 --- a/doc/modules/ROOT/pages/usage.adoc +++ b/doc/modules/ROOT/pages/usage.adoc @@ -239,6 +239,8 @@ If you ever forget any of Projectile's keybindings just do a: kbd:[s-p C-h] +== Customizing Projectile's Keybindings + It is possible to add additional commands to `projectile-command-map` referenced by the prefix key in `projectile-mode-map`. You can add multiple keymap prefix for all @@ -270,3 +272,65 @@ add to your Emacs config: NOTE: Note that the `Super` keybindings are not usable in Windows, as Windows makes heavy use of such keybindings itself. Emacs Prelude already adds those extra keybindings. + +== Projectile Commander + +Projectile's Commander (`projectile-commander`) is a nifty utility for those of you who are struggling to remember a lot of keybindings. It provides a simple +interface to most of Projectile's commands via 1-character shortcuts that you +need to press after invoking the commander (e.g. via kbd:[s-p m]). + +The commander was created with the idea to provide a powerful project switching command (it will be triggered if you press `C-u s-p p`), but it's very useful on its own as well. + +|=== +| 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. +|=== |
