A keyboard-driven, vim-like browser based on Python and Qt.

website |blog |FAQ |contributing |releases |installing

qutebrowser is a keyboard-focused browser with a minimal GUI. It’s basedon Python and Qt and free software, licensed under the GPL.

It was inspired by other browsers/addons like dwb and Vimperator/Pentadactyl.

qutebrowser’s primary maintainer, The-Compiler, is currently workingpart-time on qutebrowser, funded by donations. To sustain this for a longtime, your help is needed! See theGitHub Sponsors page oralternative donation methodsfor more information. Depending on your sign-up date and howlong you keep a certain level, you can get qutebrowser t-shirts, stickers andmore!

See theGitHub releasespage for available downloads and theINSTALL file fordetailed instructions on how to get qutebrowser running on various platforms.

Please see thehelp page for available documentationpages and support channels.

You want to contribute to qutebrowser? Awesome! Please readthe contribution guidelines for details anduseful hints.

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

• Use the built-in:report command or the automatic crash dialog.

• Open an issue in the Github issue tracker.

• Write a mail to themailinglist atqutebrowser@lists.qutebrowser.org.

Please report security bugs tosecurity@qutebrowser.org(or if GPG encryption is desired, contactme@the-compiler.org with GPG ID0x916EB0C8FD55A072).

Alternatively,report a vulnerabilityvia GitHub’sprivate reporting feature.

The following software and libraries are required to run qutebrowser:

• Python 3.9 or newer

• Qt, either 6.2.0 or newer, or 5.15.0 or newer, with the following modules:

  • QtCore / qtbase

  • QtQuick (part of qtbase or qtdeclarative in some distributions)

  • QtSQL (part of qtbase in some distributions)

  • QtDBus (part of qtbase in some distributions; note that a connection to DBus atruntime is optional)

  • QtOpenGL

  • QtWebEngine (if using Qt 5, 5.15.2 or newer), or

  • alternatively QtWebKit (5.212) -This is not recommended due to known security issues in QtWebKit, you most likely want to use qutebrowser with the default QtWebEngine backend (based on Chromium) instead. Quoting theQtWebKit releases page:[The latest QtWebKit] release is based on [an] old WebKit revision with knownunpatched vulnerabilities. Please use it carefully and avoid visiting untrustedwebsites and using it for transmission of sensitive data.

• PyQt 6.2.2 or newer(Qt 6) or 5.15.0 or newer (Qt 5)

• jinja2

• PyYAML

On macOS, the following libraries are also required:

• pyobjc-core and pyobjc-framework-Cocoa

The following libraries are optional:

• adblock (for improved adblocking using ABP syntax)

• pygments for syntax highlighting with:view-sourceon QtWebKit, or when using:view-source --pygments with the (default)QtWebEngine backend.

• On Windows,colorama for colored logoutput.

• asciidoc to generate the documentation for the:helpcommand, when using the git repository (rather than a release).

Seethe documentation for directions on how toinstall qutebrowser and its dependencies.

qutebrowser’s primary maintainer, The-Compiler, is currently workingpart-time on qutebrowser, funded by donations. To sustain this for a longtime, your help is needed! See theGitHub Sponsors page for moreinformation. Depending on your sign-up date and how long you keep a certainlevel, you can get qutebrowser t-shirts, stickers and more!

GitHub Sponsors allows for one-time donations (using the buttons next to "Select atier") as well as custom amounts.For currencies other than Euro or Swiss Francs, thisis the preferred donation method. GitHub usesStripe to acceptpayment via credit cards without any fees. Billing via PayPal is available as well, withless fees than a direct PayPal transaction.

Alternatively, the following donation methods are available — note thateligibility for swag (shirts/stickers/etc.) is handled on a case-by-case basisfor those, pleaseget in touch for details.

• Liberapay, which can handle paymentsvia Credit Card, SEPA bank transfers, or Paypal. Payment fees are paid by me,but they arerelatively low.

• SEPA bank transfer inside Europe (no fees):

  • Account holder: Florian Bruhin

  • Country: Switzerland

  • IBAN (EUR): CH13 0900 0000 9160 4094 6

  • IBAN (other): CH80 0900 0000 8711 8587 3

  • Bank: PostFinance AG, Mingerstrasse 20, 3030 Bern, Switzerland (BIC: POFICHBEXXX)

  • If you need any other information: Contact me atmail@qutebrowser.org.

  • If possible,please consider yearly or semi-yearly donations, becauseof the additional overhead from many individual transactions forbookkeeping/tax purposes.

• PayPal:CHF,EUR,USD.Note: Fees can be very high (around 5-40%, depending on the donated amounts) - considerusing GitHub Sponsors (credit card), Liberapay (credit cards, PayPal, or banktransfer) or SEPA bank transfers instead.

• Cryptocurrencies:

  • Bitcoin: bc1q3ptyw8hxrcfz6ucfgmglphfvhqpy8xr6k25p00

  • Bitcoin Cash: 1BnxUbnJ5MrEPeh5nuUMx83tbiRAvqJV3N

  • Ethereum: 0x10c2425856F7a8799EBCaac4943026803b1089c6

  • Litecoin: MDt3YQciuCh6QyFmr8TiWNxB94PVzbnPm2

  • Others: Pleaseget in touch, I’d happily set up anythingsupported by Ledger Live

Thanks a lot toMacStadium for supportingqutebrowser with a free hosted Mac Mini via theirOpen Source Project.

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

Thanks to theHSR Hochschule für Technik Rapperswil, whichmade it possible to work on qutebrowser extensions as a student research project.

qutebrowser’s primary author is Florian Bruhin (The Compiler), but qutebrowserwouldn’t be what it is without the help ofhundreds of contributors!

Additionally, the following people have contributed graphics:

• Jad/yelo (new icon)

• WOFall (original icon)

• regines (key binding cheatsheet)

Also, thanks to everyone who contributed to one of qutebrowser’scrowdfunding campaigns!

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

This program is free software: you can redistribute it and/or modifyit under the terms of the GNU General Public License as published bythe 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 ofMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See theGNU General Public License for more details.

You should have received a copy of the GNU General Public Licensealong with this program. If not, seehttps://www.gnu.org/licenses/gpl-3.0.txt.

qutebrowser optionally usespdf.js todisplay 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 canfind a copy of the license inqutebrowser/3rdparty/pdfjs/LICENSE (in theWindows release or after runningscripts/dev/update_3rdparty.py), or onlinehere.