Getting Help with Omarchy

A practical guide to asking for help in the Discord #omarchy-help forum and to filing a good GitHub issue against Omarchy.

The difference between a question that gets solved in ten minutes and one that sits unanswered is almost never luck. It is preparation: reproducing the problem, collecting the right details, and presenting them so a volunteer can understand the issue without asking five follow-up questions.


Table of contents


0. Where should I ask?

Omarchy keeps its channels deliberately separate. Using the wrong one gets your request closed or ignored, not because people are unkind but because the maintainers use these queues for different jobs.

Your situation Go here
"How do I…?", "Is this expected?", "Something's off but I'm not sure it's a bug" Discord #omarchy-help
A bug you can reproduce on the latest version, in Omarchy itself GitHub issue
A feature idea, change to an existing feature, or other suggestion GitHub Discussions → Suggestions
A security vulnerability Follow the repository's private security-reporting policy (do not post publicly)
A question about an app Omarchy merely ships (e.g. a browser, an editor) That app's own support channel first

The rules of thumb:

Official links:


1. The universal rules (read these once)

These apply to a Discord post, a GitHub issue, and almost any technical help request anywhere.

  1. Reproduce it. A bug that cannot be reproduced can rarely be fixed. If you can reproduce it reliably, say so and give the steps. If it is intermittent, say how often and what seems to influence it.
  2. Minimize it. Strip away everything that is not needed to trigger the problem. The smaller the example, the faster someone finds the cause.
  3. Search first. Search the Discord and the existing GitHub issues before posting. If it has been asked and answered, you save everyone time. If it has been reported but is unsolved, add your details to the existing thread instead of opening a duplicate.
  4. Be precise, not verbose. Volume is not precision. "It doesn't work" and a 40-line dump of unrelated logs are equally unhelpful. Give the exact error text, the exact command, and the exact result.
  5. Report symptoms, not guesses. Describe what you observed. If you have a theory, label it clearly as a theory ("I suspect the NVIDIA driver, but I haven't confirmed it").
  6. One problem per post or issue. Do not bundle three unrelated bugs into one report. It makes them impossible to track and close.
  7. Show your homework. List what you already tried and what happened. This proves you are not wasting a volunteer's time and often reveals the answer on its own.
  8. Follow up. Reply when you get more information, say thank you, and — most importantly — post the solution when it is found, so the next person finds it.

The single best question to ask yourself before submitting: "Could a stranger with the same hardware and software reproduce this using only what I've written?" If not, add what is missing.


2. Asking for help in Discord #omarchy-help

#omarchy-help is a forum channel. That means each request becomes its own post with a title and a body, rather than scrolling away in a busy chat. This is a gift: your post stays findable, and you can be replied to in a thread. Use it well.

A complete first post typically gets a useful answer without any back-and-forth. An incomplete one triggers a slow game of "what GPU do you have?" — so put the details in up front.

2.1 Before you post

Spend five minutes here. It is the highest-leverage five minutes in the whole process.

2.2 Writing the title

The title is your one chance to attract the person who knows the answer. A good title names the object and the deviation from expected behavior, in about 60 characters or fewer.

Good Why
External monitor goes black after suspend on NVIDIA Names object (external monitor) + trigger (suspend) + hardware
Bar clock shows wrong timezone after update to 4.0.4 Specific, searchable, versioned
Super+Return opens two terminals after adding keybinding Names the exact keybinding and the symptom
Bad Why
HELP!!! Says nothing, gets ignored
Omarchy is broken No object, no deviation
Problem with my computer Unsearchable and unactionable
Can someone help me please? Asking to ask

2.3 The body: the eight essentials

A strong body answers these eight questions. You do not need eight headings, but every answer should be somewhere in the post.

  1. Goal / what you were doing. The task you were trying to accomplish and the steps you took. Describe the goal, not just the step you are stuck on.
  2. What actually happened. The observed result. Include exact error text verbatim.
  3. What you expected to happen. Concrete and specific.
  4. Steps to reproduce. Numbered, from a known starting state. State whether it happens every time, sometimes, or once. Include any special setup.
  5. System and hardware details. See 2.4.
  6. Logs and error output. See 2.6.
  7. What you already tried. And the result of each attempt.
  8. When it started / what changed. Did it work before? After which update, change, or event did it break?

Optional but valuable: a screenshot or short recording for anything visual (2.7), and any workaround you found.

2.4 Gathering system and hardware details

Always include the Omarchy version. Add hardware details that are plausibly related to the problem — for graphics, audio, monitors, suspend, Wi-Fi, and input issues, hardware is usually the whole story.

omarchy version          # exact Omarchy version, e.g. 4.0.4-1
uname -r                 # kernel version (matters for hardware/driver issues)
inxi -Farz               # full system summary: CPU, GPU, RAM, disks, network
fastfetch                # pretty one-screen overview (alias: omarchy launch about)

When relevant, also collect:

# GPU and its kernel driver
lspci -nnk | grep -A3 -iE 'vga|3d|display'

# USB devices (input, audio, webcams, dongles)
lsusb

# Hyprland / compositor
hyprctl version
hyprctl monitors         # resolution, refresh rate, scale per output

A compact hardware line that belongs in almost every post:

Omarchy 4.0.4-1, kernel 6.12.5, AMD Ryzen 9 9950X, NVIDIA RTX 5090 (proprietary driver 570), two 27" 4K monitors @ 144Hz, Hyprland 0.56

If you cannot run inxi or fastfetch, the omarchy debug report below includes inxi -Farz for you.

2.5 The one-command report: omarchy debug

This is the single most useful thing you can attach. It gathers the information people ask for most often into one file.

# Print the report to the terminal and save it to /tmp/omarchy-debug.log.
# ALWAYS use --no-sudo --print in a scripted/non-interactive context so it
# never hangs waiting for a sudo password prompt.
omarchy debug --no-sudo --print

The report contains:

Sharing it:

Privacy note: this report includes your hostname, package list, and hardware serial-ish details. Skim it before posting publicly. It does not include your files.

2.6 Copying logs and error output

Start with omarchy debug (2.5). For anything it does not cover, use the sources below.

Journal (systemd) — the general-purpose log:

journalctl -b -p 3                 # errors from the current boot
journalctl -b -p 4..1              # warnings + errors from the current boot
journalctl --since "10 min ago"    # a time window around the problem
journalctl -u <unit>               # a specific system service
journalctl --user -u <unit>        # a specific user service
journalctl -f                      # follow live, then reproduce the issue
journalctl -k -b                   # kernel messages this boot (dmesg equivalent)

For a bug that happens now, reproduce it while journalctl -f is running, then copy the lines around the failure.

Hyprland (the compositor):

hyprctl configerrors               # config parse errors — check this first
hyprctl monitors                   # output configuration
hyprctl clients                    # open windows and their properties

Hyprland's runtime log lives at:

$XDG_RUNTIME_DIR/hypr/$HYPRLAND_INSTANCE_SIGNATURE/hyprland.log

Omarchy shell / bar (Quickshell): the shell logs to the journal, so filter the user journal around the time of the problem:

journalctl --user -b -p 4..1 | grep -iE 'qs|quickshell|omarchy'
omarchy restart shell              # restart it, then re-check the journal

Screen recording failures: rerun with debug enabled and attach the log:

OMARCHY_SCREENRECORD_DEBUG=true omarchy screenrecord --fullscreen
# ... reproduce ...
omarchy screenrecord --stop-recording
# then attach /tmp/omarchy-screenrecord.log

Crashes / process disappeared:

coredumpctl list                   # recently crashed processes
coredumpctl info <pid|name>        # details for one crash
coredumpctl gdb <pid|name>         # load it in gdb for a backtrace

Omarchy can also help: omarchy crash watch watches for crashes, and clicking a crash notification (or running omarchy agent crash <pid>) offers an AI diagnosis. omarchy toggle crash capture toggles the notifications.

Update failures:

omarchy update analyze logs        # check the update log for known failures

Copying text out of a terminal:

2.7 Screenshots and screen recordings

For visual bugs — rendering glitches, a bar that overlaps, a window that won't tile, a flicker — a capture is worth a thousand words.

omarchy screenshot                              # smart interactive flow
omarchy capture screenshot region               # select a region
omarchy capture screenshot windows              # pick a window
omarchy capture screenshot fullscreen save      # straight to disk, prints path

omarchy screenrecord --fullscreen               # start recording
# ...reproduce the problem on camera...
omarchy screenrecord --stop-recording           # stop, prints the saved path

Keep recordings short and focused on the misbehavior — a 10-second clip beats a 5-minute one. Shrink large files before sharing with omarchy transcode <input>. See 2.8 for how to attach them.

2.8 Formatting your post in Discord

How you present information determines whether people read it.

2.9 Etiquette and follow-through

2.10 Copy-paste template for #omarchy-help

Copy this into your post and fill in the blanks. Delete anything that does not apply.

**Title:** <object> — <deviation>  (e.g. "External monitor goes black after suspend on NVIDIA")

**What I was trying to do**
...

**What happened**
...

**What I expected**
...

**Steps to reproduce**
1.
2.
3.
Frequency: always / sometimes / once

**System / hardware**
- Omarchy: <output of `omarchy version`>
- Kernel: <output of `uname -r`>
- CPU / GPU: ...
- Monitors / other relevant hardware: ...

**Logs / errors**
```log
<paste the relevant lines here>
```
Full `omarchy debug` report: <logs.omarchy.org URL or attached file>

**What I already tried**
- ...

**When it started / what changed**
...

**Extra**
Screenshot/recording: <attach>

2.11 Good vs. bad examples

Bad post

Title: help

Hi, my omarchy is broken, the screen keeps messing up after I close my laptop. I tried stuff but nothing works. Can someone help me? I really need this fixed today. Also sometimes the bar disappears.

Problems: no version, no hardware, no steps, no logs, vague symptom ("messing up"), multiple issues in one post, urgency, no evidence of any troubleshooting.

Good post

Title: External monitor goes black after suspend on NVIDIA, requires replug

What I was trying to do: Use an external 4K monitor with my laptop and suspend/resume it.

What happened: After resuming from suspend, the external monitor is black but the laptop panel works. hyprctl monitors still lists it at the right resolution. Unplugging and replugging the cable fixes it until the next suspend. Happens every time.

Expected: Both monitors come back after resume.

Steps to reproduce:

  1. Connect the monitor over DisplayPort.
  2. systemctl suspend, then wake the machine.
  3. External monitor is black.

System / hardware:

Logs:

<relevant `journalctl -b` lines around resume>

Full report: <logs.omarchy.org/...>

What I already tried: hyprctl reload (no change); switching to a TTY and back (no change); omarchy update (already current); reverting my only custom Hyprland keybinding (no change).

When it started: After the 4.0.4 update; worked on 4.0.3.

Extra: 8-second recording attached showing the black screen and the replug fix.

This post can be triaged immediately.


3. Filing a GitHub issue

GitHub issues are the permanent, searchable record of a confirmed bug. They are the right tool only once a problem has been reproduced and confirmed to be a bug in Omarchy itself.

3.1 When to file an issue (and when not to)

File an issue when:

Do not file an issue for:

The repository disables blank issues and routes Suggestions and Support through its template chooser, so you will be pointed to the right place automatically.

3.2 What Omarchy's bug template asks for

Omarchy's bug template is intentionally short. It asks for two things:

  1. System details — required. For example: AMD 9950X, NVIDIA 5090, Omarchy 2.1.0
  2. What's wrong? — required. Describe the issue, include steps to recreate it if possible, and attach the output of omarchy debug if possible.

The template header reminds you that "Omarchy is an open source gift, not a product you bought from a vendor." Keep that in mind throughout.

Because the template is minimal, the quality of your issue is entirely up to how much of the structure below you include. A great issue goes well beyond the two required fields.

3.3 Anatomy of a great issue

Element What it answers Example
Title What is broken, specifically Bar workspace indicator stops updating after theme change
System details On what hardware/version Framework 13 (AMD 7840U), Omarchy 4.0.4-1, kernel 6.12.5
Summary One-paragraph description What is broken and in what context
Steps to reproduce How to trigger it Numbered, minimal, from a clean state
Expected result What should happen Concrete
Actual result What does happen Verbatim error text, separate from speculation
Frequency Always / sometimes / once "Every time" or "~1 in 5 resumes"
Diagnostics The evidence omarchy debug output or logs.omarchy.org URL
Minimal reproduction The smallest failing case A config diff, exact commands, a theme file
Regression info When it broke "Worked on 4.0.3, broken on 4.0.4" (or git bisect result)
Workaround Any way around it "Reverting the theme fixes it"
Captures Visual evidence Short recording or annotated screenshot

Write the issue so a maintainer can reproduce it without asking you a single follow-up question.

3.4 Gathering diagnostics for an issue

The tools are the same as for Discord; the difference is that a GitHub issue should be self-contained and permanent.

# 1. Exact versions
omarchy version
uname -r

# 2. The full diagnostic report (also written to /tmp/omarchy-debug.log)
omarchy debug --no-sudo --print

# 3. For a shareable, permanent-ish link: run the interactive form and choose
#    "Upload log". It uploads to logs.omarchy.org (link expires after 24h) and
#    prints a URL you can paste into the issue.
omarchy debug

Then add the specific evidence for your bug:

Because logs.omarchy.org links expire in 24 hours, also paste the key lines inline or attach the log file to the issue so the evidence survives.

3.5 Building a minimal reproduction for Omarchy

A minimal reproduction is the most valuable thing in any bug report. For Omarchy, it usually takes one of these forms:

Minimize by removing everything unrelated. If you can trigger the bug with one line of config and one command, you have a reproduction that will get fixed.

3.6 Attaching logs, images, and videos

3.7 Titles and labels

3.8 Filing with the gh CLI

The GitHub CLI is the fastest way to search, file, and follow up.

# Search existing issues first — avoid duplicates
gh search issues --repo omacom/omarchy "external monitor suspend"
gh issue list --repo omacom/omarchy --state open --search "monitor black"

# File a new issue from a prepared body file (write it once, reuse it)
gh issue create --repo omacom/omarchy \
  --title "External monitor goes black after suspend on NVIDIA" \
  --body-file /tmp/issue.md

# Follow up
gh issue view <number> --repo omacom/omarchy
gh issue comment <number> --repo omacom/omarchy --body "Additional info: ..."

Prepare the body with the template in 3.10. Remember that media must be attached through the web UI afterwards.

3.9 Conduct and follow-through

3.10 Copy-paste template for a GitHub issue

### System details

- Omarchy: <`omarchy version`>
- Kernel: <`uname -r`>
- CPU / GPU: ...
- Relevant hardware (monitors, audio, Wi-Fi, input, laptop model): ...

### What's wrong?

<One-paragraph summary.>

### Steps to reproduce

1.
2.
3.

Frequency: always / sometimes / once

### Expected result

...

### Actual result

...
```log
<verbatim error output / relevant log lines>
```

### Diagnostics

- Full `omarchy debug`: <logs.omarchy.org URL> and/or attached `omarchy-debug.log`
- Relevant `journalctl` / Hyprland log lines: (above)

### Minimal reproduction

<Exact config diff, command, or file needed to trigger the bug. State whether
stock config/theme works.>

### Regression

- Last known good version: ...
- First known bad version: ...
- `git bisect` result (if available): ...

### Workaround

...

### Captures

<Attach a short recording or screenshot for visual bugs.>

3.11 Good vs. bad examples

Bad issue

Title: Doesn't work

Omarchy broke my audio. Fix it. I'm on a Dell. I need this working for a meeting tomorrow. Please help ASAP.

Problems: no version, no hardware detail, no logs, no reproduction, demands and urgency, filed as a bug when it is a support question.

Good issue

Title: HDMI audio device disappears after plugging in USB-C dock

System details: Dell XPS 13 9340, Intel Core Ultra 7 155H, Intel Arc integrated graphics, Omarchy 4.0.4-1, kernel 6.12.5-arch1-1, PipeWire 1.2.7.

What's wrong?: When I connect an Anker 555 USB-C dock, the built-in HDMI audio sink disappears from wpctl status and does not come back until I reboot. Reproducible every time.

Steps to reproduce: 1) Boot with no dock. 2) Confirm HDMI sink present in wpctl status. 3) Plug in the dock. 4) HDMI sink is gone.

Expected: Both the dock's audio and the HDMI audio remain available.

Actual: HDMI sink vanishes; only the dock and internal speakers remain.

Diagnostics: Full omarchy debug at <logs.omarchy.org/...>; attached journalctl -b excerpt around the plug event.

Regression: Worked on 4.0.3; first bad on 4.0.4.

Workaround: Rebooting with the dock attached keeps the sink available.

Captures: 15-second recording attached.

This issue can be confirmed and fixed.


Appendix A: Command quick reference

Goal Command
Show Omarchy version omarchy version
Kernel version uname -r
Full diagnostic report omarchy debug --no-sudo --print
Upload diagnostic report omarchy debug → "Upload log"
Full system summary inxi -Farz
Pretty system overview fastfetch
GPU + driver lspci -nnk | grep -A3 -iE 'vga|3d|display'
Hyprland version / outputs hyprctl version / hyprctl monitors
Hyprland config errors hyprctl configerrors
Reload Hyprland hyprctl reload
Recent errors this boot journalctl -b -p 3
Logs in a time window journalctl --since "10 min ago"
Follow logs live journalctl -f
Kernel messages journalctl -k -b
Restart the shell/bar omarchy restart shell
Restore a config to default omarchy refresh <app>
Check update failures omarchy update analyze logs
List crashed processes coredumpctl list
Crash details coredumpctl info <pid|name>
Screenshot (region) omarchy capture screenshot region
Screen recording omarchy screenrecord --fullscreen / --stop-recording
OCR text from screen omarchy capture text
Shrink a capture omarchy transcode <input>
Discover commands omarchy commands / omarchy <group> --help

Appendix B: Where to find logs

What Where
Everything Omarchy collects omarchy debug --no-sudo --print → /tmp/omarchy-debug.log
System journal journalctl (-b, -p, --since, -u)
Kernel messages journalctl -k -b (or sudo dmesg)
Hyprland runtime log $XDG_RUNTIME_DIR/hypr/$HYPRLAND_INSTANCE_SIGNATURE/hyprland.log
Hyprland config errors hyprctl configerrors
Omarchy shell / bar user journal (journalctl --user)
Screen recording /tmp/omarchy-screenrecord.log (with OMARCHY_SCREENRECORD_DEBUG=true)
Crashes coredumpctl info <pid|name>
Update failures omarchy update analyze logs
Screenshots configured Pictures directory (override: OMARCHY_SCREENSHOT_DIR)
Screen recordings configured Videos directory (override: OMARCHY_SCREENRECORD_DIR)

Appendix C: Sources and further reading

This guide distills established bug-reporting practice and Omarchy's own documentation:


When in doubt: reproduce it, minimize it, gather omarchy debug, and post the whole story in one message. That is 90% of getting help.