vimium-native

KO | EN

gitlite — search

#javascript #hacktoberfest #typescript #golang #go #android #machine-learning #rust #docker #nodejs #awesome #pytorch #mcp #ios

(★ 57)

Vimium on your MacOS

파일 탐색기

최종 버전 다운로드 (.zip)

- - bug_report.md
  - feature_request.md
  - questions.md
- - main.swift
.editorconfig
.gitignore
CODE_OF_CONDUCT.md
CONTRIBUTING.md
LICENSE
Package.swift
README.md
SECURITY.md

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Overview

`VimiumNative` is a free and open-source MacOS app that allows you to use your
mac without mouse in your day to day. It's some combination of other tools like
`HomeRow`, `Shortcat`, `Mouseless`, `Warpd`. To some degree you may use this app
as an alternative to any of them. If you find that some part lacks in
functionality or performance it's highly encouraged to contribute to the project
:)

P.S. More about contribution to the project could be found
[here](./CONTRIBUTING.md)

# Quick demo

https://github.com/user-attachments/assets/de0c46ed-926b-4da0-998f-dea710d05745

If the video fails to play you can view it on my
[GitHub pages](https://abilkhan024.github.io/vimium-native-demo.mp4)

## Breakdown

Let's breakdown what is being showed on the demo, to start using the app

### Hints

Trigger hint view by pressing `Cmd + Shift + .` which will hint interactive
elements, which you can click, if some hints overlap you can toggle their
z-index by pressing `;`

### Hints with search

Trigger hint view by pressing default key binding of `Cmd + Shift + .` which
will hint interactive elements, press `/` which will enter search mode and start
typing the text that you want to click, once the hint is focused press enter

### Grid & Mouse

Trigger grid view by pressing default key binding of `Cmd + Shift + ,` which
will show labeled cells where you can place your mouse, and left click using
`<CR>` (aka Enter), or right click using `.`, or move your mouse using `hjkl`
(directions are just like in vi), toggle dragging by pressing `v`, show grid
hint again to place mouse to different point using `/`

### Scroll

Trigger scrolling by pressing default key binding of `Cmd + Shift + j`, now you
can use keys `d,u,<S>h,<S>j,<S>k,<S>l` directions are just like in vi (`<S>`
indicates shift) to scroll the current cursor position which is center of screen
by default

## Keybindings

Every keybinding used in this demo can be customized using config file more in
[options](#options)

# Getting started

## Install

```sh
# Tap formula that contains latest build
brew tap abilkhan024/tools

# Install latest build
brew install vimium-native
```

## Upgrade via homebrew

```sh
brew upgrade vimium-native
```

## Uninstall

If you didn't like the application you can easily uninstall it by following:

_P.S. constructive criticism is appreciated in the `Issues` section_

```sh
# Uninstall binary
brew uninstall vimium-native
# Untap homebrew formula
brew untap abilkhan024/tools
```

# Options

Config file will be read from $HOME/.config/vimium or `$VIMIUM_CONFIG_PATH` if
it's set

Default config:

```sh
# Key bindings, format is <Mod>{key} mapping can be found in 
# `Sources/VimiumNative/Core/KeyMapping.swift` -> `let mappingToValue`
key_show_hints='<D><S>.'
key_show_grid='<D><S>,'
key_start_scroll='<D><S>j'
key_close='<Esc>'
key_enter_search_mode='/'
key_next_search_occurence='<Tab>'
key_prev_search_occurence='<S><Tab>'
key_select_occurence='<CR>'
key_drop_last_search_char='<BS>'
key_toggle_z_index=';'
key_mouse_left='h'
key_mouse_down='j'
key_mouse_up='k'
key_mouse_right='l'
key_scroll_left='<S>h'
key_scroll_down='<S>j'
key_scroll_up='<S>k'
key_scroll_right='<S>l'
key_scroll_page_down='d'
key_scroll_page_up='u'
key_scroll_full_down='<S>g'
key_scroll_full_up='g'
key_enter_visual='v'
key_reopen_grid_view='/'
key_right_click='.'
key_left_click='<CR>'

# Font family used in hints use vimium list-fonts to view all fonts
font_family=system

# Letter spacing for hint text
letter_spacing=0.0

# Font size of the hint label
hint_font_size=14.0

# Height of the triangle indicating point that will be clicked
hint_triangle_height=6.0

# Mouse params when entering grid mode:
# Color by default
mouse_color_normal=#ff0000
# Color when dragging
mouse_color_visual=#00ffff
# Color of the outline when in mouse mode
mouse_outline_color=#00ffff
# Hides Outline when set to 0
mouse_outline_width=8.0
# Virtual circle cursor size
mouse_size=10.0

# Scroll scale vertical when using jk, horizontal for hl, verticalPage: du
scroll_size_vertical=5
scroll_size_horizontal=40
scroll_size_vertical_page=100

# Cursor move size
cursor_step=5

# Colors used for hints
color_bg=#e6d278
color_fg=#000000

# Chars that will be used when generating hints
hint_chars=jklhgasdfweruio

# Some websites may use text as buttons. You can enable this to hint text nodes,
# but it may slow down rendering, sometimes significantly.
# P.s HomeRow doesn't do it, that's why it's false by default
hint_text=false

# Rows and cols dimensions when using grid mode.
# Change is a trade-off between precision and performance
grid_rows=36
grid_cols=36
grid_font_size=14.0

# Sometimes macOS refuses to register drag when you immediately jump
# between labels. You can enable this flag to jiggle once you start dragging
jiggle_when_dragging=false

# Indicates your preferred abc layout i.e. layout
# that contains english letters, layout will be switched to it when selecting label
# set to random value e.g. "nil" if you don't want the described behaviour
abc_layout=com.apple.keylayout.ABC

# Controls if menu item should be visible in the system tray: true | false
show_menu_item=true

# Determines the children count for node to be "small", if the node
# is considered direct children are evaluated on element bound visibility
# otherwise it stops traversal if intersection with all parents results
# invisible bound. Meant as a trade off to make it fast for apps with good
# accessibilities, and good enough for apps with inconsistent tree structure.
# Adjust based on your preference. Smaller == faster (potentially missed hints),
# higher == slower more elements to discover
small_node_threshold=750

# Click the element using AXUIElementPerformAction works amazing if
# the button is under some overlay, but ignores currently held modifiers
# (like shift, cmd, etc.) so opening link in new tab would be impossible
# true by deafult set to false if you want physical click
ax_click=false

# INFO: Color that is used to show borders of element rect defaults to .3 of color_bg
# set as #00000000 if want to remove it from the view
hint_border=#00000000
```

# Building from source

```sh
# Prerequisites: 
# - Clone however you want and cd into the dir
# - Ensure that dev utils are installed so swift is available and matches
#   with Package.swift version (6.0 as of now)

# Build in release mode
swift build -c release

# Run
.build/release/VimiumNative
```

## Build for distribution

Shown for transparency of the build step, no need to run it

```sh
# Build the application striping symbols & remove unnecessary files that expose symbols
swift build --disable-prefetching -Xswiftc -gnone -c release --scratch-path ./vimium-native-build && \
tar -czvf vimium-native-build.tar.gz --no-xattrs -C vimium-native-build/release VimiumNative && \
rm -rf ./vimium-native-build
```

# Known limitations

- Multiple screen navigation, fzfind works for main screen only _(feel free to
  contribute if that's an issue)_
- Smooth scrolling _(feel free to contribute if that's an issue)_
- AeroSpace support. Due to how aerospace manages workspaces, hinting behaviour
  is unstable and unpleasant to work with, instead prefer some manager that
  won't change window sizes and their positions, e.g. custom hammerspon

vimium-native

파일 탐색기

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

vimium-native

파일 탐색기

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README