omarchy / themes

OMARCHY THEMES / DOCUMENTATION

Publish and get listed

Naming rules, the install command, getting onto omarchy.org, and how this gallery imports themes.

← All documentation

Publish and get listed

Naming the repository

Follow the omarchy-<name>-theme convention. Omarchy takes the last path segment of the clone URL, strips .git, removes a leading omarchy- and a trailing -theme, and lowercases what is left. That remainder becomes both the directory name and the name in the theme picker.

Because the result becomes a directory name that Omarchy passes around, it is validated rather than sanitised. The first character must be a letter, a digit or an underscore; the rest may be letters, digits, ., _, + and -. Capitals are lowercased for you. Anything else — a space, a quote, an accented character — is refused at install time with an error, not turned into a directory.

RepositoryInstalls as
omarchy-tokyo-night-themetokyo-night
omarchy-flexoki_light-themeflexoki_light
omarchy-c++-themec++
omarchy-Harbor-Themeharbor

The install command

omarchy theme install https://github.com/you/omarchy-harbor-theme.git

Omarchy checks the URL names a repository rather than a Git transport helper, clones it into ~/.config/omarchy/themes/harbor, and applies it immediately. SSH URLs work too. If a theme of that name is already installed, it is replaced. The same thing is available from the menu under Install > Style > Theme.

This is also how every theme in this gallery installs, including palettes published from the Theme Studio — those are served as small read-only Git repositories, so the native installer handles them with no account and no extra tooling.

Before you publish

  • A README.md with a screenshot, what the theme is for, and background credits.
  • A LICENSE, and a note if the backgrounds are licensed differently from the palette.
  • A preview.png, so the theme picker shows something.
  • No .lua, no terminal configs, no vscode.json — they are dropped on install, so a theme that depends on them is broken for everyone but you.
  • A real install test from the published URL on a machine that has never had the theme.

Getting listed on omarchy.org

Omarchy’s own extra themes page is maintained in the website repository. To be added, send a pull request to omacom/omarchy-site . Listings there carry a screenshot and a link to your repository.

Ready to make one?

The Theme Studio builds a palette in the browser, measures contrast as you pick, and publishes an installable repository.

Open the Theme Studio