Omarchy Package Split Documentation: Location and File Reference Guide

The official Omarchy package split documentation is located in docs/package-split.md on the quattro branch of the basecamp/omarchy repository, with supplementary implementation details found in docs/cli-router.md, AGENTS.md, and default/hypr/bindings/tiling.lua.

The Omarchy package split documentation provides architectural guidance for understanding how the Omarchy operating system separates its components across distinct packages and command structures. Located within the quattro branch of the open-source basecamp/omarchy repository, this documentation spans multiple markdown files and source configuration files that collectively explain the split-package architecture, command-line routing conventions, and window management bindings.

Primary Documentation File

The definitive guide for Omarchy's package split architecture resides at docs/package-split.md. This file contains the authoritative explanation of how Omarchy splits its packages, build and install procedures, and the naming conventions used across the distributed architecture. You can access this documentation directly on GitHub at:

https://github.com/basecamp/omarchy/blob/quattro/docs/package-split.md

Beyond the primary markdown guide, several additional files define and implement the split functionality:

CLI Router Documentation (docs/cli-router.md)

This file defines the command-line routing logic that processes split commands. According to the Omarchy source code, docs/cli-router.md describes how command names are split on hyphens and routed to appropriate handlers, which is essential for understanding the package-split CLI interface.

Agent Configuration (AGENTS.md)

Located in the repository root, AGENTS.md lists the specific agents that interact with package-split operations. These agents manage the lifecycle and coordination of split packages within the Omarchy environment.

Window Management Bindings (default/hypr/bindings/tiling.lua)

For practical implementations of split functionality at the window manager level, default/hypr/bindings/tiling.lua contains the Hyprland window tiling bindings that implement split-window operations. This file demonstrates how package-level split concepts translate to user interface interactions.

Accessing Documentation via Command Line

You can reference the package split documentation directly from the Omarchy CLI:


# Display help for split operations

omarchy help split

# Open the documentation in your default browser

xdg-open https://github.com/basecamp/omarchy/blob/quattro/docs/package-split.md

These commands access the same canonical documentation defined in the docs/package-split.md file, ensuring you are viewing the version-specific guidance for the quattro branch.

Summary

  • docs/package-split.md serves as the primary Omarchy package split documentation, detailing architectural separation and naming conventions.
  • docs/cli-router.md explains the command-line routing system that processes split package commands.
  • AGENTS.md catalogs the agents responsible for managing package-split operations.
  • default/hypr/bindings/tiling.lua provides concrete implementations of split functionality for window management.
  • All documentation targets the quattro branch, accessible via direct GitHub URLs or the omarchy help split CLI command.

Frequently Asked Questions

Where exactly is the Omarchy package split documentation stored?

The documentation is stored in docs/package-split.md within the quattro branch of the basecamp/omarchy GitHub repository. This location is the canonical source for split-package architecture details, build instructions, and naming conventions.

How does the Omarchy CLI handle package split commands?

According to docs/cli-router.md, the CLI router splits command names on hyphens to route them to appropriate handlers. This architecture allows for modular package commands that follow the split-package naming conventions defined in the main documentation.

What is the difference between package splits and window splits in Omarchy?

Package splits refer to the architectural separation of Omarchy components into discrete installable units as documented in docs/package-split.md, while window splits refer to the window manager tiling functionality implemented in default/hypr/bindings/tiling.lua. The former concerns software distribution architecture, while the latter concerns user interface window management.

Which agents manage package split operations?

The AGENTS.md file in the repository root lists the specific agents that interact with package-split operations. These agents coordinate the installation, configuration, and lifecycle management of split packages within the Omarchy operating system.

Have a question about this repo?

These articles cover the highlights, but your codebase questions are specific. Give your agent direct access to the source. Share this with your agent to get started:

Share the following with your agent to get started:
curl -s "https://instagit.com/install.md"

Works with
Claude Codex Cursor VS Code OpenClaw Any MCP Client

Maintain an open-source project? Get it listed too →