# The Irix Color Palette

Irix is an "architectonic" color palette system based on Radix colors — five chambers of four hues each, with twelve named shades per hue — and a set of CLI tools to apply it to the local system.

The palette itself ships as YAML data inside the package, in dark and light variants.
On top of that data sit three small layers, from most- to least-general:

- **`Palette`** loads a palette variant from packaged (or arbitrary) YAML and resolves hue names,
  `hue-shade` expressions, or raw hex values into concrete hex color strings.

- **`Color`** addresses a single palette entry by integer chamber, hue, and shade indices, with
  flexible string-based construction.

- **`ColorCoder`** (console script `colorcode`) drives the terminal background color from
  directory and command triggers evaluated at every shell prompt.

Alongside those, a small standalone toolbox (`promptcode`, `kittyhud`, `themecode`) applies the same palette to prompts, a Kitty HUD, and foreign editor themes; and the **`irix` console script** is a deploy engine in its own right — it lists, generates, drift-checks, and deploys palette-derived artifacts (kitty/alacritty/VSCode/Rust/CSS/...) for every registered target, driven by a small policy/mechanism split (see [](architecture.md)).

## Usage

```sh
uv tool install irix     # provides the `colorcode` console script
colorcode -d "$PWD"      # apply the color triggered by the current directory
colorcode -c slate       # set an explicit hue immediately

irix targets             # list every registered deploy target
irix check                # drift-check rendered artifacts against out/
irix deploy kitty vscode  # copy selected artifacts to their local config destinations
```

## Contents

### Tutorial

```{toctree}
:maxdepth: 2
1. Getting Started <tutorial>
```

### How-to Guides

```{toctree}
:maxdepth: 2
1. Deploy a Target <howto-deploy>
2. Add a New Target <howto-new-target>
3. Work with Dark/Light Modes <howto-modes>
```

### Explanation

```{toctree}
:maxdepth: 2
1. System Architecture <architecture>
2. Color Semantics & Psychology Research <color-semantics-research>
3. Rust TUI Pixel Graphics Research <research-rust-tui-pixel-graphics>
```

### Reference

```{toctree}
:maxdepth: 2
1. Color Addressing <color>
2. Palette Loading <palette>
3. Terminal Colorcodes <colorcode>
4. Shared Terminal Primitives <term>
5. Path-to-Color Segments <pathcode>
6. Kitty HUD <kittyhud>
7. Bulletin Presence <presence>
8. OKLCH Color Primitives <oklch>
9. Semantic Role Map <semantics>
10. Theme File Adapters <schemes>
11. Theme Adapt/Generate/Check <themecode>
12. Deploy-Target Registry <targets>
13. Editor Targets <targets.editors>
14. Portable/Creative Targets <targets.portable>
15. Shell-Tooling Targets <targets.shell>
16. Terminal-Emulator Targets <targets.terminals>
17. Irix CLI <cli>
18. Deploy Engine <deploy>
```