Omarchy

https://omarchy.org/manual
Admin
Omarchy is an omakase Linux distribution based on Arch Linux, Hyprland, and Quickshell, designed for...
Tokens:43,202
Snippets:381
Trust Score:9.3
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Create and start Proxmox VM for unattended install

Source: https://omarchy.org/manual/unattended-installs

Full Proxmox example: creates a VM named 'my-omarchy' with UEFI, VirtIO SCSI, and attaches the Omarchy ISO and cidata.iso as CD-ROMs. Boot order lists the disk first so the empty disk falls through to the ISO on first boot. Then starts the VM.

```bash
qm create 101 --name my-omarchy \
  --bios ovmf --machine q35 --cpu host --cores 4 --memory 8192 \
  --ostype l26 --scsihw virtio-scsi-single \
  --efidisk0 local-lvm:0,efitype=4m,pre-enrolled-keys=0 \
  --scsi0 local-lvm:40,discard=on,iothread=1 \
  --net0 virtio,bridge=vmbr0 --vga virtio --serial0 socket \
  --ide2 local:iso/omarchy.iso,media=cdrom \
  --ide3 local:iso/cidata.iso,media=cdrom \
  --boot order='scsi0;ide2'

qm start 101

```

--------------------------------

### Start a service on session start in autostart.lua

Source: https://omarchy.org/manual/dotfiles

Add this line to ~/.config/hypr/autostart.lua to start a command as part of the session. The command is properly cleaned up when you log out.

```lua
o.launch_on_start("my-service")
```

--------------------------------

### omarchy menu command examples

Source: https://omarchy.org/manual/omarchy-cli

Examples of using the `omarchy menu` command to open the menu at the root, jump to a specific point in the tree, toggle a menu, and close it.

```text
omarchy menu
```

```text
omarchy menu summon style.theme
```

```text
omarchy menu toggle system
```

```text
omarchy menu close
```

--------------------------------

### 1x scaling for 1080p/1440p displays

Source: https://omarchy.org/manual/monitors

Use for 1080p or 1440p displays to get 1x scaling. Edit ~/.config/hypr/monitors.lua via Setup > Monitors in the Omarchy menu. Changes to GDK_SCALE apply to applications started after the change.

```lua
local omarchy_gdk_scale = 1
local omarchy_monitor_scale = 1

```

--------------------------------

### Install Ruby with Mise

Source: https://omarchy.org/manual/development-tools

Use `mise use -g ruby` to install Ruby and set it as the global default. Alternatively, if your project has a .ruby-version file, run `mise i` in the project root.

```bash
mise use -g ruby
```

```bash
mise i
```

--------------------------------

### Toggle command example

Source: https://omarchy.org/manual/toggles-idle-screensaver

Example of using the omarchy-toggle-enabled command to check if a toggle is enabled, returning an exit code for scripting.

```bash
omarchy-toggle-enabled screensaver-off && echo "screensaver is off"

```

--------------------------------

### Control the Windows VM with omarchy windows vm commands

Source: https://omarchy.org/manual/windows-vm

Use these commands to check status, stop, or launch the Windows VM. The launch command starts the VM and connects over RDP; use --keep-alive to leave it running after closing the RDP window.

```bash
omarchy windows vm status    # is it running?
omarchy windows vm stop      # shut it down
omarchy windows vm launch    # start and connect
```

--------------------------------

### Omarchy shell.json bar configuration

Source: https://omarchy.org/manual/the-top-bar

Example of the Omarchy shell configuration file stored at ~/.config/omarchy/shell.json under the bar key. Widgets are entries in the left, center, and right layout arrays with inline settings; centerAnchor pins the named widget to the exact center of the screen. Once you have your own shell.json it is canonical - there is no deep merge, so new default widgets won't appear automatically.

```json
{
  "version": 1,
  "bar": {
    "position": "top",
    "transparent": false,
    "centerAnchor": "omarchy.clock",
    "layout": {
      "left": [{ "id": "omarchy.menu" }, { "id": "omarchy.workspaces" }],
      "center": [{ "id": "omarchy.clock", "format": "HH:mm" }],
      "right": [{ "id": "omarchy.audio" }, { "id": "omarchy.power" }]
    }
  }
}
```

--------------------------------

### Build cidata ISO with genisoimage

Source: https://omarchy.org/manual/unattended-installs

Creates a cidata directory, copies the required configuration files into it, and generates a cidata.iso with the volume label 'cidata' using genisoimage. This ISO is then attached to the VM alongside the Omarchy ISO.

```bash
mkdir cidata
cp user_configuration.json user_credentials.json authorized_keys cidata/
genisoimage -output cidata.iso -volid cidata -joliet -rock cidata/

```

--------------------------------

### Enable sudoless Docker

Source: https://omarchy.org/manual/development-tools

Run `omarchy-setup-security-sudoless-docker` to add your user to the docker group, allowing plain `docker` and the `d` alias without sudo. This is a security tradeoff.

```bash
omarchy-setup-security-sudoless-docker
```

--------------------------------

### Hyprsunset time profile configuration

Source: https://omarchy.org/manual/toggles-idle-screensaver

Example configuration for hyprsunset to set a time-based temperature profile, replacing the default identity profile.

```ini
profile {
    time = 20:00
    temperature = 4000
}

```

--------------------------------

### Add a plugin from git with --enable

Source: https://omarchy.org/manual/shell-plugins

Adds a third-party plugin from a git repository with a manifest.json at its root. Prompts for confirmation because plugins run as arbitrary, unsandboxed code; clones to a staging directory, validates the manifest, refuses if the id is already claimed, and moves it to ~/.config/omarchy/plugins/<id>/. With --enable it enables immediately; without it, asks whether to enable now.

```shell
omarchy plugin add https://github.com/acme/omarchy-weather.git --enable

```

--------------------------------

### Override keybinding in ~/.config/hypr/bindings.lua

Source: https://omarchy.org/manual/dotfiles

Replace the default Obsidian keybinding with Joplin by editing ~/.config/hypr/bindings.lua. Install Joplin first with omarchy-pkg-add joplin-bin.

```lua
hl.unbind("SUPER + SHIFT + O")
o.bind("SUPER + SHIFT + O", "Joplin", "joplin-desktop")

```

--------------------------------

### List plugins with omarchy plugin list

Source: https://omarchy.org/manual/shell-plugins

Lists every discovered plugin with its id, enabled state, first-party or third-party status, kinds, and display name. Add --json for machine-readable output.

```shell
omarchy plugin list

```

--------------------------------

### GitHub CLI authentication

Source: https://omarchy.org/manual/development-tools

Authenticate with GitHub using `gh auth login`. The `gh` command is a lazy-loading mise stub that installs itself on first run.

```bash
gh auth login
```

--------------------------------

### Bar control commands

Source: https://omarchy.org/manual/the-top-bar

Commands for controlling the bar's position, transparency, widget placement, and widget settings. Useful for dotfiles setup. The `defaults` command restores the shipped layout.

```bash
omarchy bar position bottom
omarchy bar transparent toggle
omarchy bar move omarchy.clock --section center --index 0
omarchy bar set omarchy.clock format "HH:mm"
omarchy bar defaults          # back to the shipped layout
```

--------------------------------

### Fractional scaling for 4K displays

Source: https://omarchy.org/manual/monitors

Use for 27" or 32" 4K displays to enable fractional scaling. Edit ~/.config/hypr/monitors.lua via Setup > Monitors in the Omarchy menu. GDK_SCALE only honors whole numbers, so keep it at the nearest integer of your monitor scale.

```lua
local omarchy_gdk_scale = 2
local omarchy_monitor_scale = 1.6

```
Tokens:
Raw