https://github.com/akz92/bim
Vim-inspired browser
https://github.com/akz92/bim
browser cross-platform electron keyboard-navigation macos vim vue
Last synced: 3 months ago
JSON representation
Vim-inspired browser
- Host: GitHub
- URL: https://github.com/akz92/bim
- Owner: akz92
- Created: 2018-02-17T04:39:30.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-03-17T21:50:47.000Z (over 8 years ago)
- Last Synced: 2025-08-09T22:16:43.808Z (11 months ago)
- Topics: browser, cross-platform, electron, keyboard-navigation, macos, vim, vue
- Language: JavaScript
- Size: 775 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Bim
Vim-inspired browser built with [Electron](https://github.com/electron/electron) and [Vue](https://github.com/vuejs/vue)
### Commandbar
Bim has a command bar similar to Vim's, to activate it press `:` while on `normal` mode.
There's a limited number of commands for now, these are all of them:
```shell
open # Opens a url in current tab
open -t # Opens a url in a new tab
reload # Reloads the current tab
stop # Stops reloading the current tab
tab-close N # Closes the current tab or the N-th tab (starting from 1)
tab-focus N # Focuses on the N-th tab (starting from 1)
tab-next # Focuses on the next tab
tab-prev # Focuses on the previous tab
tab-move N # Moves the current tab to the N-th position (starting from 1)
back # Navigates back in tab's history
forward # Navigates forward in tab's history
yank # Yanks current tab's url to the clipboard
inspect # Opens DevTools for the current tab
inspect -b # Opens Bim's DevTools
hints # Shows link hints
hints -t # Opens hint link in a new tab
hints -y # Yank hint link
set navbar show/hide # Hides or shows the navbar
```
### Keyboard shortcuts
Keyboard shortcuts are only recognized while on `normal` mode. I've only implemented basic commands yet, this is the shortcuts currently available:
```shell
i # Enter insert mode
/ # Search in page
o # Opens a url in current tab
shift+o # Opens a url in a new tab
f # Shows link hints
r # Reloads the current tab
x # Closes the current tab
shift+J # Focuses on the previous tab
shift+K # Focuses on the next tab
shift+H # Navigates back in tab's history
shift+L # Navigates forward in tab's history
yy # Yanks current tab's url to the clipboard
yf # Yanks hint link
wi # Opens DevTools for the current tab
```
### Running locally
```shell
# Install packages
npm install
# Start development hot reload server
npm run dev
# Start application
electron .
```
### How to build
```shell
# Install packages
npm install
# Build Vue files
npm run build
# Create package
npm run release:mac
```