qutebrowser

基于 PyQt5 的键盘驱动、类似 vim 的浏览器。「A keyboard-driven, vim-like browser based on PyQt5.」

Github星跟踪图

// If you are reading this in plaintext or on PyPi:
//
// A rendered version is available at:
// https://github.com/qutebrowser/qutebrowser/blob/master/README.asciidoc

qutebrowser

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

image:https://travis-ci.org/qutebrowser/qutebrowser.svg?branch=master["Build Status", link="https://travis-ci.org/qutebrowser/qutebrowser"]
image:https://ci.appveyor.com/api/projects/status/5pyauww2k68bbow2/branch/master?svg=true["AppVeyor build status", link="https://ci.appveyor.com/project/qutebrowser/qutebrowser"]
image:https://codecov.io/github/qutebrowser/qutebrowser/coverage.svg?branch=master["coverage badge",link="https://codecov.io/github/qutebrowser/qutebrowser?branch=master"]

link:https://www.qutebrowser.org[website], link:https://blog.qutebrowser.org[blog], https://github.com/qutebrowser/qutebrowser/blob/master/doc/faq.asciidoc[FAQ], https://www.qutebrowser.org/doc/contributing.html[contributing], link:https://github.com/qutebrowser/qutebrowser/releases[releases], https://github.com/qutebrowser/qutebrowser/blob/master/doc/install.asciidoc[installing]
// QUTE_WEB_HIDE_END

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.

// QUTE_WEB_HIDE
qutebrowser's primary maintainer, The-Compiler, is currently working
part-time on qutebrowser, funded by donations.
To sustain this for a long
time, your help is needed! See the
https://github.com/sponsors/The-Compiler/[GitHub Sponsors page] for more
information. Depending on your sign-up date and how long you keep a certain
level, you can get qutebrowser t-shirts, stickers and more!

Thanks to the GitHub Sponsors Matching Fund, all donations done via GitHub
Sponsors (up to a $5000 total) will be doubled until October 2020.
// QUTE_WEB_HIDE_END

Screenshots

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"]

Downloads

See the https://github.com/qutebrowser/qutebrowser/releases[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.

Documentation

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

  • https://raw.githubusercontent.com/qutebrowser/qutebrowser/master/doc/img/cheatsheet-big.png[Key binding cheatsheet]: +
    image:https://raw.githubusercontent.com/qutebrowser/qutebrowser/master/doc/img/cheatsheet-small.png["qutebrowser key binding cheatsheet",link="https://raw.githubusercontent.com/qutebrowser/qutebrowser/master/doc/img/cheatsheet-big.png"]
  • link:doc/quickstart.asciidoc[Quick start guide]
  • https://www.shortcutfoo.com/app/dojos/qutebrowser[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://irc.freenode.org/#qutebrowser[#qutebrowser] on
https://freenode.net/[Freenode]
(https://webchat.freenode.net/?channels=#qutebrowser[webchat]), or by writing a
message to the
https://lists.schokokeks.org/mailman/listinfo.cgi/qutebrowser[mailinglist] at
mailto:qutebrowser@lists.qutebrowser.org[].

There's also an https://lists.schokokeks.org/mailman/listinfo.cgi/qutebrowser-announce[announce-only mailinglist]
at mailto:qutebrowser-announce@lists.qutebrowser.org[] (the announcements also
get sent to the general qutebrowser@ list).

If you're a reddit user, there's a
https://www.reddit.com/r/qutebrowser/[/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
ways:

For security bugs, please contact me directly at mail@qutebrowser.org, GPG ID
https://www.the-compiler.org/pubkey.asc[0x916eb0c8fd55a072].

Requirements

The following software and libraries are required to run qutebrowser:

The following libraries are optional:

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

Donating

qutebrowser's primary maintainer, The-Compiler, is currently working
part-time on qutebrowser, funded by donations.
To sustain this for a long
time, your help is needed! See the
https://github.com/sponsors/The-Compiler/[GitHub Sponsors page] for more
information. Depending on your sign-up date and how long you keep a certain
level, you can get qutebrowser t-shirts, stickers and more!

Thanks to the GitHub Sponsors Matching Fund, all donations done via GitHub
Sponsors (up to a $5000 total) will be doubled until October 2020!

Alternatively, the following donation methods are available -- note that
eligibility for swag (shirts/stickers/etc.) is handled on a case-by-case basis
for those, please mailto:mail@qutebrowser.org[get in touch] for details.

Sponsors

Thanks a lot to https://www.macstadium.com/[MacStadium] for supporting
qutebrowser with a free hosted Mac Mini via their
https://www.macstadium.com/opensource[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 https://www.hsr.ch/[HSR Hochschule für Technik Rapperswil], which
made it possible to work on qutebrowser extensions as a student research project.

image:doc/img/sponsors/macstadium.png["powered by MacStadium",width=200,link="https://www.macstadium.com/"]
image:doc/img/sponsors/hsr.png["HSR Hochschule für Technik Rapperswil",link="https://www.hsr.ch/"]

Authors

qutebrowser's primary author is Florian Bruhin (The Compiler), but qutebrowser
wouldn't be what it is without the help of
https://github.com/qutebrowser/qutebrowser/graphs/contributors[hundreds of contributors]!

Additionally, the following people have contributed graphics:

  • Jad/link:https://yelostudio.com[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!

Active


* https://fanglingsu.github.io/vimb/[vimb] (C, GTK+ with WebKit2)
* https://luakit.github.io/luakit/[luakit] (C/Lua, GTK+ with WebKit2)
* https://surf.suckless.org/[surf] (C, GTK+ with WebKit1/WebKit2)
* https://github.com/next-browser/next/[next] (Lisp, Emacs-like but also offers Vim bindings, various backends - note there was a http://jgkamat.gitlab.io/blog/next-rce.html[critical remote code execution] which was handled quite badly)
* https://github.com/parkouss/webmacs/[webmacs] (Python, Emacs-like with QtWebEngine)
* Chrome/Chromium addons:
  https://vimium.github.io/[Vimium],
* Firefox addons (based on WebExtensions):
  https://github.com/tridactyl/tridactyl[Tridactyl],
  https://addons.mozilla.org/en-GB/firefox/addon/vimium-ff/[Vimium-FF] (experimental),
  https://github.com/ueokande/vim-vixen[Vim Vixen],
  https://github.com/amedama41/vvimpulation[VVimpulation]
* Addons for Firefox and Chrome:
  https://github.com/brookhong/Surfingkeys[Surfingkeys],
  https://github.com/lusakasa/saka-key[Saka Key],
  https://krabby.netlify.com/[Krabby],
  https://lydell.github.io/LinkHints/[Link Hints] (hinting only)
* Addons for Safari:
  https://televator.net/vimari/[Vimari]

Inactive

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.

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

pdf.js

qutebrowser optionally uses https://github.com/mozilla/pdf.js/[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
https://www.apache.org/licenses/LICENSE-2.0.html[here].

主要指标

概览
名称与所有者qutebrowser/qutebrowser
主编程语言Python
编程语言Python (语言数: 12)
平台
许可证GNU General Public License v3.0
所有者活动
创建于2014-06-26 14:59:34
推送于2025-05-20 06:12:33
最后一次提交
发布数94
最新版本名称v3.5.0 (发布于 2025-04-12 21:28:50)
第一版名称v0.1 (发布于 2014-12-14 20:46:44)
用户参与
星数10.5k
关注者数168
派生数1k
提交数25.5k
已启用问题?
问题数5666
打开的问题数1146
拉请求数1765
打开的拉请求数98
关闭的拉请求数435
项目设置
已启用Wiki?
已存档?
是复刻?
已锁定?
是镜像?
是私有?