qutebrowser

A keyboard-driven browser.

Installing qutebrowser

On Debian / Ubuntu

qutebrowser should run on these systems:

  • Debian jessie or newer

  • Ubuntu Trusty (14.04 LTS) or newer

  • Any other distribution based on these (e.g. Linux Mint 17+)

Unfortunately there is no Debian package in the official repos yet, but installing qutebrowser is still relatively easy!

You can use packages that are built for every release or build it yourself from git.

Using the packages

Install the dependencies via apt-get:

# apt-get install python3-lxml python-tox python3-pyqt5 python3-pyqt5.qtwebkit python3-pyqt5.qtquick python3-sip python3-jinja2 python3-pygments python3-yaml

Get the qutebrowser package from the release page and download the PyPEG2 package.

Install the packages:

# dpkg -i python3-pypeg2_*_all.deb
# dpkg -i qutebrowser_*_all.deb

Build it from git

Install the dependencies via apt-get:

Note

On Debian, it’s recommended to install the Qt packages from the experimental repository as those are a much newer version of Qt which is more stable.

Add the following line to your /etc/apt/sources.list:

deb http://ftp.debian.org/debian experimental main

Then install the packages like this:

# apt-get update
# apt-get install -t experimental python3-pyqt5 python3-pyqt5.qtwebkit python3-pyqt5.qtquick python3-sip python3-dev
# apt-get install python-tox

It’s also recommended to pin those packages to receive updates by creating a file /etc/apt/preferences.d/qutebrowser with the following contents:

Package: python3-pyqt5* libqt5*
Pin: release a=experimental
Pin-Priority: 800

For distributions other than Debian or if you prefer to not use the experimental repo:

# apt-get install python3-pyqt5 python3-pyqt5.qtwebkit python3-pyqt5.qtquick python-tox python3-sip python3-dev

To generate the documentation for the :help command, when using the git repository (rather than a release):

# apt-get install asciidoc source-highlight
$ python3 scripts/asciidoc2html.py

If video or sound don’t seem to work, try installing the gstreamer plugins:

# apt-get install gstreamer1.0-plugins-{bad,base,good,ugly}

On Fedora

qutebrowser is available in the official repositories for Fedora 22 and newer.

# dnf install qutebrowser

On Archlinux

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 seem to work, try installing the gstreamer plugins:

# pacman -S gst-plugins-{base,good,bad,ugly} gst-libav

On Gentoo

qutebrowser is available in the main repository and can be installed with:

# emerge -av qutebrowser

Make sure you have python3_4 in your PYTHON_TARGETS (/etc/portage/make.conf) and rebuild your system (emerge -uDNav @world) if necessary.

If video or sound don’t seem to work, try installing the gstreamer plugins:

# emerge -av gst-plugins-{base,good,bad,ugly,libav}

On Void Linux

qutebrowser is available in the official repositories and can be installed with:

# xbps-install qutebrowser

On NixOS

Nixpkgs collection contains pkgs.qutebrowser since June 2015. You can install it with:

$ nix-env -i qutebrowser

On openSUSE

There are prebuilt RPMs available for Tumbleweed and Leap 42.1:

Or add the repo manually:

# zypper addrepo http://download.opensuse.org/repositories/home:arpraher/openSUSE_Tumbleweed/home:arpraher.repo
# zypper refresh
# zypper install qutebrowser

On OpenBSD

qutebrowser is in OpenBSD ports.

Manual install:

# cd /usr/ports/www/qutebrowser
# make install

Or alternatively if you’re using -current (or OpenBSD 6.1 once it’s been released):

# pkg_add qutebrowser

On Windows

There are different ways to install qutebrowser on Windows:

Prebuilt binaries

Prebuilt standalone packages and MSI installers are built for every release.

Chocolatey package

  • PackageManagement PowerShell module

PS C:\> Install-Package qutebrowser
  • Chocolatey’s client

C:\> choco install qutebrowser

Manual install

$ pip install tox

On OS X

Prebuilt binary

The easiest way to install qutebrowser on OS X is to use the prebuilt .app files from the release page.

This binary is also available through the Homebrew Cask package manager:

$ brew cask install qutebrowser

Manual Install

Alternatively, you can install the dependencies via a package manager (like Homebrew or MacPorts) and run qutebrowser from source.

Homebrew

$ brew install qt5
$ pip3 install qutebrowser

Homebrew’s builds of Qt and PyQt no longer include QtWebKit - if you need QtWebKit support, it is necessary to build from source. The build takes several hours on an average laptop.

$ brew install qt5 --with-qtwebkit
$ brew install -s pyqt5
$ pip3 install qutebrowser

Packagers

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.

Installing qutebrowser with tox

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 tox inside the qutebrowser repository to set up a virtual environment:

$ tox -e mkvenv

On Windows, run tox with the mkvenv-win option, however make sure that ONLY Python3 is in your PATH before running tox.

$ tox -e mkvenv-win

This installs all needed Python dependencies in a .venv subfolder. The system-wide Qt5/PyQt5 installations are symlinked into the virtual environment.

You can then 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 "$@"

If you are developing on qutebrowser, you may want to redirect it to a local config:

#!/bin/bash
~/path/to/qutebrowser/.venv/bin/python3 -m qutebrowser -c .qutebrowser-local "$@"

Updating

When you updated your local copy of the code (e.g. by pulling the git repo, or extracting a new version), the virtualenv should automatically use the updated code. However, if dependencies got added, this won’t be reflected in the virtualenv. Thus it’s recommended to run the following command to recreate the virtualenv:

$ tox -r -e mkvenv