Nix

Release versions of Quickshell are available from Nixpkgs under the quickshell package.

The Quickshell repo also has an embedded flake which can be used from either mirror:

• git+https://git.outfoxxed.me/outfoxxed/quickshell
• github:quickshell-mirror/quickshell

{
  inputs = {
    nixpkgs.url = "nixpkgs/nixos-unstable";

    quickshell = {
      # add ?ref=<tag> to track a tag
      url = "git+https://git.outfoxxed.me/outfoxxed/quickshell";

      # THIS IS IMPORTANT
      # Mismatched system dependencies will lead to crashes and other issues.
      inputs.nixpkgs.follows = "nixpkgs";
    };
  };
}

The package is available as quickshell.packages.<system>.default, which can be added to your environment.systemPackages, home.packages if you use home-manager, or a devshell.

When using the flake, additional QML packages can be added to Quickshell’s environment using <package>.withModules [ <extra modules> ].

Arch

Quickshell is available from the aur under:

• the quickshell package for the latest release
• the quickshell-git package that tracks the master branch

Install using the command below:

yay -S quickshell
# or
yay -S quickshell-git

(or your AUR helper of choice)

Fedora

Quickshell is available from the errornointernet/quickshell COPR, as either:

• quickshell that tracks the latest release
• quickshell-git that tracks the master branch

Install using the command below:

sudo dnf copr enable errornointernet/quickshell

sudo dnf install quickshell
# or
sudo dnf install quickshell-git

Guix

Release versions of Quickshell are available from the standard Guix repository as quickshell from the (gnu packages wm) module.

Install using the command below:

guix install quickshell

You can also add quickshell to your Guix system configuration or Guix Home configuration.

For the git version, Quickshell’s source repository works as a channel. Add the following to your channel list:

(channel
  (name quickshell)
  (url "https://git.outfoxxed.me/outfoxxed/quickshell")
  (branch "master"))

However, since the package definition is located in the source repository, it cannot be used as a channel out of the box. You can clone the repository and use guix shell -f quickshell.scm to use the git version of the package.

Manual build

See BUILD.md for build instructions and configurations.

Emacs

Install the yuja/tree-sitter-qml tree-sitter grammar, and the xhcoding/qml-ts-mode mode.

Both are packaged for nix via outfoxxed/nix-qml-support.

Either lsp-mode or eglot should be usable for LSP (caveats below).

The author’s personal emacs config uses lsp-mode and qml-ts-mode as follows:

(use-package qml-ts-mode
  :after lsp-mode
  :config
  (add-to-list 'lsp-language-id-configuration '(qml-ts-mode . "qml-ts"))
  (lsp-register-client
   (make-lsp-client :new-connection (lsp-stdio-connection '("qmlls"))
                    :activation-fn (lsp-activate-on "qml-ts")
                    :server-id 'qmlls))
  (add-hook 'qml-ts-mode-hook (lambda ()
                                (setq-local electric-indent-chars '(?\n ?\( ?\) ?{ ?} ?\[ ?\] ?\; ?,))
                                (lsp-deferred))))

Neovim

Neovim has built-in syntax highlighting for QML, however tree-sitter highlighting may work better than the built-in highlighting. You can install the grammar using :TSInstall qmljs.

To use the language server (caveats below), install nvim-lspconfig and the following snippet to your configuration:

require("lspconfig").qmlls.setup {}

Helix

Helix has built-in syntax highlighting and qmlls support.

Vscode

1. Install the Official QML Support extension
2. Enable the qt-qml.qmlls.useQmlImportPathEnvVar setting.