01. Overview & Architecture

Profile: v2.0.0
Schema validatedSource pinned
Purpose
The original warm retro palette for Vim.
Compatibility
Any distro (Server: BOTH)
Window Manager & Theme
Any WM / DE / Gruvbox

02. Installation & Deployment

Before you installThis changes your desktop configuration. 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.
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.
ImpactAlso runs (not undone by rollback): nvim +"colorscheme gruvbox"
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/morhetz/gruvbox ~/0xtsoa-review/morhetz-gruvbox# 1. clone to a review folder
$git -C ~/0xtsoa-review/morhetz-gruvbox checkout --detach ef8864bb42bf244f0295d1c5a403b27e3d139695# 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
1Add the plugin (lazy.nvim)
$# lua: { "morhetz/gruvbox", lazy = false, priority = 1000 }
2Activate the colorscheme
$nvim +"colorscheme gruvbox"
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/morhetz/gruvbox/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. Screenshot Gallery // Gruvbox

Capture 01 // Fullscreen
Screenshot Dark
01 / 03

04. Documentation & Guide

Source: morhetz/gruvboxRef: ef8864bb42
README.md|GitHub Flavored Markdown

Note

Long time no see, folks. morhetz here.
I'm building a desktop database client rn.
If you're interested in early access once it's ready, drop me a line at t5qQuRzLpVxe@morhetz.com.

gruvbox is heavily inspired by badwolf, jellybeans and solarized.

Designed as a bright theme with pastel 'retro groove' colors and light/dark mode switching in the way of solarized. The main focus when developing gruvbox is to keep colors easily distinguishable, contrast enough and still pleasant for the eyes.

Attention

  1. Read this first
  2. Typeface from gallery is Fantasque Sans Mono
  3. Typeface from screenshots below is Fira Mono

Screenshots

Refer Gallery for more syntax-specific screenshots.

Dark mode

Screenshot Dark

Light mode

Screenshot Light

Airline theme

Screenshot Airline

Palette

Dark mode

Palette Dark

Light mode

Palette Light

Contrast options

Refer wiki section for contrast configuration and other options.

Contrast Options

Documentation

Please check wiki for installation details, terminal-specific setup, troubleshooting, configuration options and others.

Features

Contributions

See gruvbox-contrib repo for contributions, ports and extras.

ToDo

  • Filetype syntax highlighting (R, TeX, Swift, Erlang)
  • Plugin support (Tagbar, VimPlug)

Self-Promotion

If you like gruvbox follow the repository on GitHub and vote for it on vim.org.

License

MIT/X11

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