A keyboard-driven, vim-like browser based on PyQt5 and Qt.
qutebrowser is a keyboard-focused browser with a minimal GUI. It’s based on Python and PyQt5 and free software, licensed under the GPL.
It was inspired by other browsers/addons like dwb and Vimperator/Pentadactyl.
Downloads
See the github releases page for available downloads and the INSTALL file for detailed instructions on how to get qutebrowser running on various platforms.
Contributions / Bugs
You want to contribute to qutebrowser? Awesome! Please read the contribution guidelines for details and useful hints.
If you found a bug or have a feature request, you can report it in several ways:
-
Use the built-in
:reportcommand or the automatic crash dialog. -
Open an issue in the Github issue tracker.
-
Write a mail to the mailinglist at qutebrowser@lists.qutebrowser.org.
Requirements
The following software and libraries are required to run qutebrowser:
-
Python 3.5 or newer (3.6 recommended)
-
Qt 5.7.1 or newer with the following modules:
-
QtCore / qtbase
-
QtQuick (part of qtbase in some distributions)
-
QtSQL (part of qtbase in some distributions)
-
QtOpenGL
-
QtWebEngine, or
-
QtWebKit - only the updated fork (5.212) is supported
-
-
PyQt 5.7.0 or newer (5.9.2 recommended) for Python 3
The following libraries are optional:
See the documentation for directions on how to install qutebrowser and its dependencies.
Donating
Working on qutebrowser is a very rewarding hobby, but like (nearly) all hobbies it also costs some money. Namely I have to pay for the server and domain, and do occasional hardware upgrades [1].
If you want to give me a beer or a pizza back, I’m trying to make it as easy as possible for you to do so. If some other way would be easier for you, please get in touch!
-
PayPal: me@the-compiler.org
-
Bitcoin: 1PMzbcetAHfpxoXww8Bj5XqquHtVvMjJtE
qutebrowser’s primary author is Florian Bruhin (The Compiler), but qutebrowser wouldn’t be what it is without the help of hundreds of contributors!
Additionally, the following people have contributed graphics:
-
Jad/yelo (new icon)
-
WOFall (original icon)
-
regines (key binding cheatsheet)
Similar projects
Many projects with a similar goal as qutebrowser exist. Most of them were inspirations for qutebrowser in some way, thanks for that!
Active
-
vimb (C, GTK+ with WebKit2)
-
luakit (C/Lua, GTK+ with WebKit2)
-
surf (C, GTK+ with WebKit1/WebKit2)
-
uzbl (C, GTK+ with WebKit1/WebKit2)
-
Chrome/Chromium addons: cVim, Vimium, Surfingkeys, Saka Key
-
Firefox addons (based on WebExtensions): Vimium-FF (experimental), Saka Key, Vim Vixen, QuantumVim, Tridactyl (working on a better API for keyboard integration in Firefox).
Inactive
-
dwb (C, GTK+ with WebKit1, unmaintained - main inspiration for qutebrowser)
-
vimprobable (C, GTK+ with WebKit1)
-
jumanji (C, GTK+ with WebKit1)
-
conkeror (Javascript, Emacs-like, XULRunner/Gecko)
-
Firefox addons (not based on WebExtensions or no recent activity): Vimperator, Pentadactyl, VimFx,
License
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
pdf.js
qutebrowser optionally uses pdf.js to display PDF files in the browser. Windows releases come with a bundled pdf.js.
pdf.js is distributed under the terms of the Apache License. You can
find a copy of the license in qutebrowser/3rdparty/pdfjs/LICENSE (in the
Windows release or after running scripts/dev/update_3rdparty.py), or online
here.
1. It turned out a 160 GB SSD is rather small - the VMs and custom Qt builds I use for testing/developing qutebrowser need about 100 GB of space