Quickshell

▲ 0✓Sign-Off

01. Overview & Architecture 02. Installation & Deployment 03. Documentation & Guide

01. Overview & Architecture

Profile: v0.3.2

Schema validatedSource pinned

Purpose: QtQuick toolkit for building bars, widgets and whole desktop shells in QML.
Compatibility: Any distro (Server: WAYLAND)
Desktop Part: Widgets & shells
Window Manager & Theme: Any WM / DE / Other

02. Installation & Deployment

Before you installThis changes your desktop configuration and installs packages. Run it as your normal user, never with sudo: it asks for sudo only where a step needs it (listed below).The guided installer shows its plan first. Files it would replace are kept unless you approve. Everything it copies, clones or appends to in your home folder is backed up and verified first, and --rollback restores it. Packages, sudo changes and the other commands listed under Impact are not undone.

Origingithub.com/quickshell-mirror/quickshellPinned to 2b4501a28268 · reviewed in this config file

IntegrityEach release from main builds the installers in GitHub Actions and signs them with a GitHub build attestation. Verify your download against the repository, not this website (Option B, step 2). If it does not verify, don't run it.

ImpactPackages: quickshell

RecoveryGuided: backups in ~/.local/state/0xtsoa/backups/, undo with bash install.sh --rollback.Manual: the steps below only write in the download folder or run listed commands.

Option A: manual installAdvanced

Read the source at the reviewed commit, back up, then run each step yourself.

$git clone https://github.com/quickshell-mirror/quickshell ~/0xtsoa-review/quickshell-mirror-quickshell# 1. clone to a review folder

$git -C ~/0xtsoa-review/quickshell-mirror-quickshell checkout --detach 2b4501a282689792b62e94f3fb30d8f512324fe6# 2. the reviewed commit

Then the steps. Package commands are written for Arch; on other distros use your package manager.

Step-by-step deployment protocol

Step-by-step deployment

1Install quickshell (Arch repos)

Shell commands

$sudo pacman -S --needed quickshell

$# Other distros: see the upstream README

Option B: guided installerRecommended

The same steps as one script for any distro. It shows the plan first, keeps files you already have unless you approve replacing them, and backs up everything it changes in your home folder. Never pipe it into a shell.

$curl -fsSLo install.sh 'https://www.0xtsoa.dev/configs/quickshell-mirror/quickshell/install.sh'# 1. download

gh attestation verify install.sh --repo nyharena25/0xTsoa --signer-workflow nyharena25/0xTsoa/.github/workflows/attest-installers.yml

# 2. verify (GitHub CLI 2.49+, signed in)

$less install.sh# 3. read it

$bash install.sh --dry-run# 4. preview: changes nothing

$bash install.sh# 5. install (asks first)

$bash install.sh --rollback# undo the file changes

View script in browserOther options: --force (replace conflicts, backed up first), --yes, --help

03. Documentation & Guide

Source: quickshell-mirror/quickshellRef: 2b4501a282

README.md|GitHub Flavored Markdown

Raw Source ↗

Quickshell

See the website for more information and installation instructions.

This repo is hosted at:

Contributing / Development

HACKING.md - Development instructions and policy.
CONTRIBUTING.md - Contribution policy.
BUILD.md - Packaging and build instructions.

License

^{Licensed under the GNU LGPL 3.}
_{Unless you explicitly state otherwise, any contribution submitted
for inclusion shall be licensed as above, without any additional
terms or conditions.}

GitHub Flavored Markdown (github-markdown-css)README snapshot at 2b4501a282