How to install qutebrowser depends a lot on the version of Debian/Ubuntu you’re running.
Ubuntu 16.04 doesn’t come with an up-to-date engine (a new enough QtWebKit, or QtWebEngine). However, it comes with Python 3.5, so you can install qutebrowser in a virtualenv.
You’ll need some basic libraries to use the virtualenv-installed PyQt:
# apt install libglib2.0-0 libgl1 libfontconfig1 libx11-xcb1 libxi6 libxrender1 libdbus-1-3
Debian Stretch comes with QtWebEngine in the repositories. This makes it possible to install qutebrowser via the Debian package.
You’ll need to download three packages:
-
PyPEG2 (a library used by qutebrowser which is not in the earlier repositories)
-
qutebrowser itself
-
Either qutebrowser-qtwebengine or qutebrowser-qtwebkit (or both) depending on the backend you want to use. QtWebEngine is the default/recommended choice.
After downloading, install the packages (make sure to install all the downloaded qutebrowser deb files in one apt command):
# apt install ./python3-pypeg2_*_all.deb # apt install ./qutebrowser*.deb
For an update after the initial install, you only need to download/install the qutebrowser package.
With those distributions, qutebrowser is in the official repositories, and you can install it with apt:
# apt install qutebrowser
-
Alternatively, you can install qutebrowser in a virtualenv to get a newer QtWebEngine version.
-
If running from git, run the following to generate the documentation for the
:helpcommand:# apt install --no-install-recommends asciidoc source-highlight $ python3 scripts/asciidoc2html.py
-
If you prefer using QtWebKit, there’s an up-to-date version available in Debian Testing.
-
If video or sound don’t work with QtWebKit, try installing the gstreamer plugins:
# apt install gstreamer1.0-plugins-{bad,base,good,ugly}
qutebrowser is available in the official repositories:
# dnf install qutebrowser
Fedora only ships free software in the repositories. To be able to play videos with proprietary codecs with QtWebEngine, you will need to install an additional package from the RPM Fusion Free repository. For more information see https://rpmfusion.org/Configuration.
# dnf install qt5-qtwebengine-freeworld
qutebrowser is available in the official [community] repository.
# pacman -S qutebrowser
There is also a -git version available in the AUR: qutebrowser-git.
You can install it using makepkg like this:
$ git clone https://aur.archlinux.org/qutebrowser-git.git $ cd qutebrowser-git $ makepkg -si $ cd .. $ rm -r qutebrowser-git
or you could use an AUR helper, e.g. yaourt -S qutebrowser-git.
If video or sound don’t work with QtWebKit, try installing the gstreamer plugins:
# pacman -S gst-plugins-{base,good,bad,ugly} gst-libav
qutebrowser is available in the main repository and can be installed with:
# emerge -av qutebrowser
If video or sound don’t work with QtWebKit, try installing the gstreamer plugins:
# emerge -av gst-plugins-{base,good,bad,ugly,libav}
To be able to play videos with proprietary codecs with QtWebEngine, you will
need to turn off the bindist flag for dev-qt/qtwebengine.
See the Gentoo Wiki for more information.
qutebrowser is available in the official repositories and can be installed with:
# xbps-install qutebrowser
It’s currently recommended to install python3-PyQt5-webengine and
python3-PyQt5-opengl, then start with --backend webengine to use the new
backend.
Since the v1.0 release, qutebrowser uses QtWebEngine by default.
Nixpkgs collection contains pkgs.qutebrowser since June 2015. You can install
it with:
$ nix-env -i qutebrowser
It’s recommended to install qt5.qtwebengine and start with
--backend webengine to use the new backend.
Since the v1.0 release, qutebrowser uses QtWebEngine by default.
There are prebuilt RPMs available at OBS.
To use the QtWebEngine backend, install libqt5-qtwebengine.
qutebrowser is available in the 3rd party repository at slackbuilds.org
An easy way to install it is with sbopkg (frontend for slackbuilds.org) available at sbopkg.org
sbopkg can be run with a dialog screen interface, or via command line options.
After installing the latest sbopkg package, choose your release version, and sync the repo.
sbopkg -V 14.2 sbopkg -r
The pyPEG2 and MarkupSafe dependencies both need building for python3. You can either set PYTHON3=yes in the shell or set those as options in the dialog menu for each.
Generate a queue file for qutebrowser and dependencies:
sqg -p qutebrowser
Then load the queue in the dialog queue menu or via:
PYTHON3=yes sbopkg -i qutebrowser
If you use the dialog screen you can deselect any already-installed packages that you don’t need/want to rebuild before starting the build process.
qutebrowser is in FreeBSD ports.
It can be installed with:
# cd /usr/ports/www/qutebrowser # make install clean
At present, precompiled packages are not available for this port, and QtWebEngine backend is also not available.
There are different ways to install qutebrowser on Windows:
Prebuilt standalone packages and installers are built for every release.
Note that you’ll need to upgrade to new versions manually (subscribe to the qutebrowser-announce mailinglist to get notified on new releases). You can install a newer version without uninstalling the older one.
The binary release ships with a QtWebEngine built without proprietary codec support. To get support for e.g. h264/h265 videos, you’ll need to build QtWebEngine from source yourself with support for that enabled.
-
PackageManagement PowerShell module
PS C:\> Install-Package qutebrowser
-
Chocolatey’s client
C:\> choco install qutebrowser
-
Scoop’s client
C:\> scoop bucket add extras C:\> scoop install qutebrowser
Use the installer from python.org to get Python 3 (be sure to install pip).
The easiest way to install qutebrowser on macOS is to use the prebuilt .app
files from the
release page.
Note that you’ll need to upgrade to new versions manually (subscribe to the qutebrowser-announce mailinglist to get notified on new releases).
The binary release ships with a QtWebEngine built without proprietary codec support. To get support for e.g. h264/h265 videos, you’ll need to build QtWebEngine from source yourself with support for that enabled.
This binary is also available through the Homebrew Cask package manager:
$ brew cask install qutebrowser
Alternatively, you can install the dependencies via a package manager (like Homebrew or MacPorts) and run qutebrowser from source.
$ brew install qt5 $ pip3 install qutebrowser
Since the v1.0 release, qutebrowser uses QtWebEngine by default.
Homebrew’s builds of Qt and PyQt don’t come with QtWebKit (and --with-qtwebkit
uses an old version of QtWebKit which qutebrowser doesn’t support anymore). If
you want QtWebKit support, you’ll need to build an up-to-date QtWebKit
manually.
There are example .desktop and icon files provided. They would go in the
standard location for your distro (/usr/share/applications and
/usr/share/pixmaps for example).
The normal setup.py install doesn’t install these files, so you’ll have to do
it as part of the packaging process.
|
Important
|
Before January 2020, this section used to be about installing
qutebrowser via tox which is a wrapper around virtualenv. Now, a dedicated
script is used instead.
|
A virtual environment (virtualenv, venv) allows Python packages to be installed in an isolated location for a particular application, rather than being installed globally.
The scripts/mkvenv.py script in this repository can be used to create a
virtualenv for qutebrowser and install it (including all dependencies) there.
The next couple of sections will explain the most common use-cases - run
mkvenv.py with --help to see all available options.
First of all, clone the repository using git and switch into the repository folder:
$ git clone https://github.com/qutebrowser/qutebrowser.git $ cd qutebrowser
Then run the install script:
$ python3 scripts/mkvenv.py
This installs all needed Python dependencies in a .venv subfolder
(which subdirectory the environment is created in is configurable via the
--venv-dir flag).
This comes with an up-to-date Qt/PyQt including a pre-compiled QtWebEngine binary, but has a few caveats:
-
Make sure your
python3is Python 3.5 or newer, otherwise you’ll get a "No matching distribution found" error. Note that qutebrowser itself also requires this. -
It only works on 64-bit x86 systems, with other architectures you’ll get the same error.
-
It comes with a QtWebEngine compiled without proprietary codec support (such as h.264).
See the next section for an alternative install method which might help with those issues but result in an older Qt version.
You can specify a Qt/PyQt version with the --pyqt-version flag, see
mkenv.py --help for a list of available versions. By default, the latest
version which plays well with qutebrowser is used.
Alternatively, you can use mkvenv.py --pyqt-type link to symlink your local
PyQt/Qt install instead of installing PyQt in the virtualenv. However, unless
you have a new QtWebKit or QtWebEngine available, qutebrowser will not work. It
also typically means you’ll be using an older release of QtWebEngine.
On Windows, run set PYTHON=C:\path\to\python.exe (CMD) or ``$Env:PYTHON =
"…"` (Powershell) first.
There is a third mode, mkvenv.py --pyqt-type source which uses a system-wide
Qt but builds PyQt from source. In most scenarios, this shouldn’t be needed.
Running mkvenv.py does not install a system-wide qutebrowser script. You can
launch qutebrowser by doing:
.venv/bin/python3 -m qutebrowser
You can create a simple wrapper script to start qutebrowser somewhere in your
$PATH (e.g. /usr/local/bin/qutebrowser or ~/bin/qutebrowser):
#!/bin/bash ~/path/to/qutebrowser/.venv/bin/python3 -m qutebrowser "$@"
To build the documentation, install asciidoc (note that LaTeX which comes as
optional/recommended dependency with some distributions is not required).
Then, run:
$ python3 scripts/asciidoc2html.py