Skip to main content

A keyboard-driven, vim-like browser based on PyQt5.

Project description

// If you are reading this in plaintext or on PyPi:
// A rendered version is available at:


image:icons/qutebrowser-64x64.png[qutebrowser logo] *A keyboard-driven, vim-like browser based on PyQt5 and Qt.*

image:["Build Status", link=""]
image:["AppVeyor build status", link=""]
image:["coverage badge",link=""]

link:[website] | link:[blog] |[FAQ] |[contributing] | link:[releases] |[installing]

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.


image:doc/img/main.png["screenshot 1",width=300,link="doc/img/main.png"]
image:doc/img/downloads.png["screenshot 2",width=300,link="doc/img/downloads.png"]
image:doc/img/completion.png["screenshot 3",width=300,link="doc/img/completion.png"]
image:doc/img/hints.png["screenshot 4",width=300,link="doc/img/hints.png"]


See the[github releases
page] for available downloads and the link:doc/install.asciidoc[INSTALL] file for
detailed instructions on how to get qutebrowser running on various platforms.


In addition to the topics mentioned in this README, the following documents are

*[Key binding cheatsheet]: +
image:["qutebrowser key binding cheatsheet",link=""]
* link:doc/quickstart.asciidoc[Quick start guide]
*[Free training course] to remember those key bindings
* link:doc/faq.asciidoc[Frequently asked questions]
* link:doc/help/configuring.asciidoc[Configuring qutebrowser]
* link:doc/contributing.asciidoc[Contributing to qutebrowser]
* link:doc/install.asciidoc[Installing qutebrowser]
* link:doc/changelog.asciidoc[Change Log]
* link:doc/stacktrace.asciidoc[Reporting segfaults]
* link:doc/userscripts.asciidoc[How to write userscripts]

Getting help

You can get help in the IRC channel
irc://[`#qutebrowser`] on[Freenode]
([webchat]), or by writing a
message to the[mailinglist] at[].

There's also an[announce-only mailinglist]
at[] (the announcements also
get sent to the general qutebrowser@ list).

If you're a reddit user, there's a[/r/qutebrowser] subreddit there.

Contributions / Bugs

You want to contribute to qutebrowser? Awesome! Please read
link:doc/contributing.asciidoc[the contribution guidelines] for details and
useful hints.

If you found a bug or have a feature request, you can report it in several

* Use the built-in `:report` command or the automatic crash dialog.
* Open an issue in the Github issue tracker.
* Write a mail to the[mailinglist] at[].

For security bugs, please contact me directly at, GPG ID[0x916eb0c8fd55a072].


The following software and libraries are required to run qutebrowser:

*[Python] 3.5 or newer (3.6 recommended)
*[Qt] 5.7.1 or newer (5.12 recommended, support for < 5.9
will be dropped soon) with the following modules:
- QtCore / qtbase
- QtQuick (part of qtbase in some distributions)
- QtSQL (part of qtbase in some distributions)
- QtOpenGL
- QtWebEngine, or
- alternatively QtWebKit - support for QtWebKit will be dropped soon, and
only the link:[updated fork] (5.212)
is supported
*[PyQt] 5.7.0 or newer
(5.12 recommended, support for < 5.9 will be dropped soon) for Python 3

The following libraries are optional:

*[cssutils] (for an improved `:download --mhtml`
with QtWebKit).
* On Windows,[colorama] for colored log
*[asciidoc] to generate the documentation for the `:help`
command, when using the git repository (rather than a release).

See link:doc/install.asciidoc[the documentation] for directions on how to
install qutebrowser and its dependencies.


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 footnote:[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].

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:
* Bitcoin: link:bitcoin:1PMzbcetAHfpxoXww8Bj5XqquHtVvMjJtE[1PMzbcetAHfpxoXww8Bj5XqquHtVvMjJtE]


Thanks a lot to[MacStadium] for supporting
qutebrowser with a free hosted Mac Mini via their[Open Source Project].

(They don't require including this here - I've just been very happy with their
offer, and without them, no macOS releases or tests would exist)

Thanks to the[HSR Hochschule für Technik Rapperswil], which
made it possible to work on qutebrowser extensions as a student research project.

image:.github/img/macstadium.png["powered by MacStadium",width=200,link=""]
image:.github/img/hsr.png["HSR Hochschule für Technik Rapperswil",link=""]


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/link:[yelo] (new icon)
* WOFall (original icon)
* regines (key binding cheatsheet)

Also, thanks to everyone who contributed to one of qutebrowser's
link:doc/backers.asciidoc[crowdfunding campaigns]!

Similar projects

Many projects with a similar goal as qutebrowser exist.
Most of them were inspirations for qutebrowser in some way, thanks for that!


*[vimb] (C, GTK+ with WebKit2)
*[luakit] (C/Lua, GTK+ with WebKit2)
*[surf] (C, GTK+ with WebKit1/WebKit2)
*[next] (Lisp, Emacs-like, GTK+ with WebKit)
*[webmacs] (Python, Emacs-like with QtWebEngine)
* Chrome/Chromium addons:[Vimium],[Surfingkeys],
* Firefox addons (based on WebExtensions):[Vimium-FF] (experimental),[Vim Vixen],[VVimpulation],[Tridactyl] (working
on a[better API] for
keyboard integration in Firefox).


*[dwb] (C, GTK+ with WebKit1,[unmaintained] -
main inspiration for qutebrowser)
*[vimprobable] (C, GTK+ with
*[jumanji] (C, GTK+ with WebKit1,
original site is gone but Arch Linux has some data)
*[conkeror] (Javascript, Emacs-like, XULRunner/Gecko)
*[uzbl] (C, GTK+ with WebKit1/WebKit2)
* Firefox addons (not based on WebExtensions or no recent activity):[Vimperator],[Pentadactyl],[VimFx],[Saka Key],[QuantumVim],
* Chrome/Chromium addons:[ViChrome],[Vrome][Saka Key],[cVim],


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
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program. If not, see <>.


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/`), or online[here].

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
qutebrowser-1.6.1.tar.gz (3.7 MB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page