search

Jelmerro / Vieb

Vim Inspired Electron Browser - Vim bindings for the web by design
https://vieb.dev
GNU General Public License v3.0
1.33k stars 65 forks source link
browser chromium electron javascript network vim

readme

icon

Vim bindings for the web by design

Website Download counter Latest release License Support Donate

Matrix Matrix Matrix Telegram Telegram

Vieb is the Vim Inspired Electron Browser

Homepage - Download - Changelog - FAQ

Vieb is pronounced like "deep" with a "v" and rhymes with sheep

screenshot

Please see vieb.dev for features, more screenshots and the cheatsheet

Download

These are the main sources to download Vieb. For startup help, see the frequently asked questions.

Vieb.dev

The official Vieb website, where you can download the latest stable release for many platforms.

Github

The same releases that are offered on vieb.dev, but with release notes and previous versions listed.

Fedora

I host a custom DNF repository that you can use for Vieb instead of downloading from vieb.dev or Github.

sudo dnf config-manager addrepo --from-repofile=https://jelmerro.nl/fedora/jelmerro.repo
sudo dnf install vieb

Third-party

These releases are made by users just like you for their favorite system. Third-party releases might be outdated (in red) or customized compared to official builds, but they are probably the simplest way to get started if your system is listed.

Third-party releases table

Erwic

With the "erwic" startup option, you can "Easily Run Websites In Containers". The purpose of this option is similar to programs such as Franz, Ferdi or Rambox. It can also replace other Electron-based desktop apps such as Slack or Discord. These instances of Vieb can run separately from your existing Vieb. See Erwic.md for usage and details.

Contribute

You can support my work on ko-fi or Github sponsors. Donating is completely optional because Vieb will always be free and open source. Another way to help is to report issues or suggest new features, either via Github discussions or Github issues. If you know how to write Electron applications, you can also help by writing code. Check the 'help wanted' issues for suggestions on what to work on. Please try to follow the linter styling when developing, see npm run lint. For an example vimrc that can auto-format based on the included linters, you can check out my personal vimrc.

Building

To create your own builds or run Vieb from source, you need to install Node.js. The next step is to clone the repository or download the source code, which can be done with the green "Code" button at the top of the page. After downloading, make sure you are in the cloned/extracted Vieb folder, then run npm ci to install the dependencies, you only need to do so once. You can now run Vieb from this folder from source with npm start. If you want to use a local datafolder to run Vieb, use npm run dev. You can do git pull and then another npm ci to update if you cloned the repo, or you can repeat these steps in a new folder if you downloaded a zip. Finally, you can generate builds for your platform with node build, or execute node build --help to see the full list of options. The selected builds will be created inside of the dist folder.

License

Vieb is created by Jelmer van Arnhem and contributors. See the source files for individual authors.

You can copy or modify the code/program under the terms of the GPL3.0 or later versions. For more information and legal terms, see the LICENSE file.