Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chrisgrieser/finder-vim-mode
Feature-rich mouseless control of macOS Finder, inspired by vim/ranger.
https://github.com/chrisgrieser/finder-vim-mode
complex-modification finder-extension karabiner-elements macos-finder macos-finder-extension vim-emulation vim-emulator vim-mode
Last synced: about 2 months ago
JSON representation
Feature-rich mouseless control of macOS Finder, inspired by vim/ranger.
- Host: GitHub
- URL: https://github.com/chrisgrieser/finder-vim-mode
- Owner: chrisgrieser
- License: mit
- Created: 2022-12-09T15:53:03.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-27T10:16:06.000Z (about 2 months ago)
- Last Synced: 2024-07-27T11:31:19.611Z (about 2 months ago)
- Topics: complex-modification, finder-extension, karabiner-elements, macos-finder, macos-finder-extension, vim-emulation, vim-emulator, vim-mode
- Language: Shell
- Homepage:
- Size: 9.66 MB
- Stars: 79
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- vim-keybindings-everywhere-the-ultimate-list - Finder Vim Mode - adds extensive vim-like/ranger-like keybindings, works via Karabiner Elements. (File Management)
README
# Vim Mode for Finder
Feature-rich control of macOS Finder without the mouse, inspired by vim and
ranger.
## Usage Examples
- `rl`: Duplicate selected file and open the copy.
- `axw`: Select all files, move them to the other window, close current window.
- `.f.d.`: Show hidden files, select first hidden file, delete it, hide dotfiles
again.
- `AM`: Select files (but not folders), create a new directory, move selected
files into that directory, and start renaming the directory (enters insert
mode).
- `azmhp`: Select all files and folders, zip them, (wait for zipping to finish),
and move the archive one directory up
## Table of Contents
- [Usage](#usage)
- [Installation](#installation)
- [Updates](#updates)
- [Caveats](#caveats)
- [Build](#build)
- [Credits](#credits)
- [About the developer](#about-the-developer)
## Usage
- Only works in Finder's `List View`.
- __`:help`__ Press `?` in Finder to display the cheatsheet above. Generally,
everything in brackets only applies to the uppercase version of the key.
- __Move__: `m` marks the current selection as "to be moved." The next
paste-operation `p` moves the files. A move can be aborted via `esc`.
- __Cross-move__: If you have *exactly* two Finder windows open, `x` moves the
selection to the other window, and `X` copies the selection to the other
window.
- __Context-menu__: Can be opened with `q` and navigated via `hjkl`. Use `esc`
or press `q` again to close the context-menu.
- __Find mode__ is triggered via `f`, works similar to `f` in vim, expecting
another character afterward. For example, `fh` jumps to the next file that
starts with the letter `h`.
- __Toggle `-bkp` suffix__: Add suffix `-bkp` to the file. If it already has
such a suffix, remove it. Useful for debugging as well.
- __`Tab`__ goes to the next file in alphabetical order, *even when the view is
not sorted alphabetically.* (This is actually a built-in feature of Finder,
but worth mentioning since barely anyone knows about it.)
- __Copy/Paste file content:__ `Y` copies the content of the selected file, while
`P` pastes text from the clipboard into the selected file (appending).
- __Copy path components__:
+ `Ctrl+p`: Absolute path
+ `Ctrl+n`: File name
+ `Ctrl+t` (if in git repo): Path relative to the repo root
- __Open in GitHub__: If the file is in a git repo, `Ctrl+g` opens the file at
GitHub and also copies the URL to the clipboard.
> [!NOTE]
> __Pressing `return` in a prompt window__, for example when replacing a file,
> mistakenly puts you in Insert Mode. Unfortunately, Karabiner is not able to
> detect whether the front window is a regular Finder window or a prompt. The
> workaround is to either press `esc` to go back to Normal Mode, or to use `tab`
> and then `space` to select the correct action in the prompt window.
## Installation
1. Run this in your terminal:
```bash
brew install karabiner-elements # Install Karabiner (if not already installed)
worktree="https://raw.githubusercontent.com/chrisgrieser/finder-vim-mode/main"
open "karabiner://karabiner/assets/complex_modifications/import?url=$worktree/finder-vim.json"
curl -sL "$worktree/extras/cheatsheet.png" --create-dirs --output "$HOME/.config/karabiner/assets/finder-vim-mode/cheatsheet.png"
curl -sL "$worktree/extras/notificator" --create-dirs --output "$HOME/.config/karabiner/assets/finder-vim-mode/notificator"
defaults write com.apple.finder FXPreferredViewStyle -string "Nlsv" # set default view to "List"
defaults write com.apple.finder CreateDesktop false # disable desktop icons & make desktop unfocussable
killall Finder
```
2. Activate the plugin: `Import` → `Enable`
3. *Karabiner users:* If you already use Karabiner and have another modification
affecting the `Capslock` key, the other modification must come __below__ the
*Finder Vim Mode* in the list of modifications. (Karabiner prioritizes
modifications further on top of the list.)
4. *Alfred users:* In [the Appearance
Options](https://www.alfredapp.com/help/appearance/#options), you need to set
the `Focusing` behavior to `Compatibility Mode` for Karabiner to detect
Alfred being active.
5. *Spotlight users:* You need to install the Spotlight addon. The addon has to
be __above__ the Finder Vim Mode in the list of modifications.
```bash
# install Spotlight addon
open "karabiner://karabiner/assets/complex_modifications/import?url=https://raw.githubusercontent.com/chrisgrieser/finder-vim-mode/main/addons/finder-vim-spotlight-addon.json"
```
6. The first time you receive a notification, you are asked whether notifications
should be allowed or not.
> [!NOTE]
> I do not use __Raycast__, but Raycast can be supported with either the
> Spotlight addon or by enabling some sort of compatibility mode. For proper
> Raycast support, please open an issue.
## Updates
Unfortunately, Karabiner has no mechanism for auto-updating plugins. Therefore,
you have to install updates manually by re-running the code above. You can check
for the last commit date to see whether there has been an update:
## Caveats
Since Karabiner plugins are only hotkey re-mappings without proper scripting
mechanisms, this plugin has some limitations:
- Only __List view__ is supported.
- If you __use the mouse to click buttons__, you can end up in the wrong mode.
In that case, you can press `esc` to get back to Normal Mode. (Or, you know,
just do not use the mouse. You're a vim user, after all.)
- File selection dialogues from other apps (for example, to upload a file in the
browser) are not supported.
- Unfortunately, it is __not possible to have a `vimrc` or to let the user
configure the keybindings__ themselves in any way, at least not with a
Karabiner plugin. If you want to rebind keys, you have to change the
respective key manually in the JSON file.
- If you have set __custom keybindings for Finder__, they can potentially
interfere. It is therefore recommended to unset them.
- The plugin has been tested with the __U.S. and German keyboard layout__. It
should mostly also work for other layouts.
- In some edge cases, not using of __English as System UI language__ can create an
issue. (You can fix this by changing to English: `System Settings → General →
Language & Region → Preferred Languages`)
## Build
Karabiner plugins are essentially hotkey configurations in form of a JSON file.
Since the amount of configurations for this plugin is rather large, the
resulting JSON file ~6000 lines. To make that manageable, this plugin is written
in YAML, where features such as [anchors and
aliases](https://www.linode.com/docs/guides/yaml-anchors-aliases-overrides-extensions/)
reduce the lines of code to only ~1000 lines.
If you want to fork this plugin, it is recommended to work with the YAML file
and "compile" it to the [JSON required by
Karabiner](https://karabiner-elements.pqrs.org/docs/json/complex-modifications-manipulator-definition/).
You can do so with [yq](https://github.com/mikefarah/yq):
```bash
# `explode()` required to resolve the anchors and aliases
yq --output-format=json 'explode(.)' finder-vim.yaml > finder-vim.json
```
## Credits
- The cheatsheet has been created with .
- The notification script is a modified version of the [Notificator by Vítor
Galvão](https://github.com/vitorgalvao/notificator).
## About the developer
In my day job, I am a sociologist studying the social mechanisms underlying the
digital economy. For my PhD project, I investigate the governance of the app
economy and how software ecosystems manage the tension between innovation and
compatibility. If you are interested in this subject, feel free to get in touch.
- [Academic Website](https://chris-grieser.de/)
- [ResearchGate](https://www.researchgate.net/profile/Christopher-Grieser)
- [Mastodon](https://pkm.social/@pseudometa)
- [LinkedIn](https://www.linkedin.com/in/christopher-grieser-ba693b17a/)
