diff --git a/AGENTS.md b/AGENTS.md index 6f0f5526..e1ddb88c 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -6,12 +6,17 @@ - Prefer `(( ))` over numeric operators inside `[[ ]]` (e.g., `(( count < 50 ))`, not `[[ $count -lt 50 ]]`) - For strings/paths with spaces, quote them instead of escaping spaces with `\ ` (e.g., `"$APP_DIR/Disk Usage.desktop"`, not `$APP_DIR/Disk\ Usage.desktop`) - Shebangs must use `#!/bin/bash` consistently (never `#!/usr/bin/env bash`) +- Scripts under `install/` and `migrations/` may be sourced and intentionally omit shebangs # Command Naming -All commands start with `omarchy-`. Prefixes indicate purpose: +All commands start with `omarchy-`. Prefixes indicate purpose. -- `cmd-` - check if commands exist +The authoritative command group list lives in `bin/omarchy` in `GROUP_DESCRIPTIONS`. Keep `GROUP_DESCRIPTIONS` updated when adding a new command prefix. + +Common prefixes include: + +- `cmd-` - check if commands exist, misc utility commands - `capture-` - screenshots, screen recordings, and other capture tools - `pkg-` - package management helpers - `hw-` - hardware detection (return exit codes for use in conditionals) @@ -24,6 +29,51 @@ All commands start with `omarchy-`. Prefixes indicate purpose: - `theme-` - theme management - `update-` - update components +Other current prefixes include: + +- `ac-`, `audio-`, `battery-`, `branch-`, `brightness-`, `channel-`, `config-`, `debug-`, `dev-`, `drive-`, `first-`, `font-`, `haptic-`, `hibernation-`, `hook-`, `hyprland-`, `menu-`, `migrate-`, `notification-`, `npx-`, `plymouth-`, `powerprofiles-`, `reinstall-`, `remove-`, `screensaver-`, `show-`, `snapshot-`, `state-`, `sudo-`, `swayosd-`, `system-`, `transcode-`, `tui-`, `tz-`, `upload-`, `version-`, `voxtype-`, `webapp-`, `wifi-`, `windows-` + +# Command Metadata + +Commands in `bin/` can declare CLI metadata in comments near the top of the file. `bin/omarchy` scans the first 80 lines, and tests expect command metadata to remain valid. + +Supported metadata keys: + +- `# omarchy:summary=...` - short help text +- `# omarchy:group=...` - command group when it differs from the filename-derived prefix +- `# omarchy:name=...` - command name within the group +- `# omarchy:args=...` - usage arguments +- `# omarchy:examples=...` - examples separated with ` | ` +- `# omarchy:alias=...` / `# omarchy:aliases=...` - alternate routes +- `# omarchy:requires-sudo=true` - mark commands that require sudo + +Prefer explicit metadata for user-facing commands. Keep routes consistent with the filename unless there is a deliberate alias or compatibility route. + +Example: + +```bash +# omarchy:summary=Take a screenshot +# omarchy:group=capture +# omarchy:args=[smart|region|windows|fullscreen] [slurp|copy] +# omarchy:examples=omarchy screenshot | omarchy capture screenshot region +# omarchy:aliases=omarchy screenshot +``` + +# Install Scripts + +Install entry points (`install.sh`, `boot.sh`) use `#!/bin/bash`. Many scripts under `install/` are sourced via `run_logged` and intentionally do not have shebangs. + +Install stage files follow this pattern: + +- `install/*/all.sh` lists scripts in execution order +- leaf scripts are sourced by `run_logged $OMARCHY_INSTALL/path/to/script.sh` +- avoid `exit` in sourced install scripts unless intentionally aborting the install +- use `$OMARCHY_INSTALL` and `$OMARCHY_PATH` instead of hard-coded Omarchy paths +- keep hardware-specific logic under `install/config/hardware/` +- prefer helper commands for package and command checks where available + +Raw `command -v`, `pacman`, and `pacman-key` are acceptable in bootstrap/preflight/package-helper contexts where the helper commands may not be available yet or where direct package-manager behavior is the point of the script. + # Helper Commands Use these instead of raw shell commands: @@ -33,6 +83,8 @@ Use these instead of raw shell commands: - `omarchy-pkg-add` - install packages (handles both pacman and AUR) - `omarchy-hw-asus-rog` - detect ASUS ROG hardware (and similar `hw-*` commands) +Exceptions are allowed for bootstrap, preflight, migration, and package-helper scripts where the helper may not be available yet, where the helper itself is being implemented, or where direct package-manager behavior is required. + # Config Structure - `config/` - default configs copied to `~/.config/` @@ -53,10 +105,15 @@ This copies `~/.local/share/omarchy/config/hypr/hyprlock.conf` to `~/.config/hyp To create a new migration, run `omarchy-dev-add-migration --no-edit`. This creates a migration file named after the unix timestamp of the last commit. -Migration format: +New migration format: - No shebang line - Start with an `echo` describing what the migration does - Use `$OMARCHY_PATH` to reference the omarchy directory +- Prefer helper commands such as `omarchy-cmd-present`, `omarchy-cmd-missing`, `omarchy-pkg-present`, and `omarchy-pkg-missing` + +Some older migrations predate these rules. Do not copy older migrations that start with shebangs, omit the leading `echo`, or hard-code `~/.local/share/omarchy`. + +Migrations may use raw `pacman`, `command -v`, or direct config edits when needed for historical compatibility or one-off repair work. Example: ```bash