# zvnoob/heirline-cmdline architecture

> Architecture diagram of the GitHub repository zvnoob/heirline-cmdline, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-09-26). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/zvnoob/heirline-cmdline
- Repository: https://github.com/zvnoob/heirline-cmdline

## Overview

heirline-cmdline is a Neovim plugin that renders command-line input and prompts in an heirline statusline, with optional completion. The documented workflow starts with Neovim command-line activity, locates a marked statusline region, displays formatted text and a fake cursor, and may show word-based completions. The README documents these capabilities, but source excerpts are unavailable, so internal call ownership and wiring cannot be verified; the graph keeps module relationships conservative.

Main entry points: [`lua/heirline-cmdline/init.lua`](https://github.com/zvnoob/heirline-cmdline/blob/main/lua/heirline-cmdline/init.lua) (Plugin setup and lifecycle), [`lua/heirline-cmdline/completion.lua`](https://github.com/zvnoob/heirline-cmdline/blob/main/lua/heirline-cmdline/completion.lua) (Completion menu), [`lua/heirline-cmdline/positioner.lua`](https://github.com/zvnoob/heirline-cmdline/blob/main/lua/heirline-cmdline/positioner.lua) (Region positioning), [`lua/heirline-cmdline/window.lua`](https://github.com/zvnoob/heirline-cmdline/blob/main/lua/heirline-cmdline/window.lua) (Floating display)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_integration["Neovim integration"]
  node_entry["Plugin setup and lifecycle<br/>[init.lua]"]
  node_config["Configuration<br/>[config.lua]"]
end

subgraph group_display["Statusline display"]
  node_positioner["Region positioning<br/>[positioner.lua]"]
  node_window["Floating display<br/>[window.lua]"]
  node_shorttext["Title formatting<br/>[shorttext.lua]"]
end

subgraph group_completion["Completion"]
  node_completion["Completion menu<br/>[completion.lua]"]
  node_sources["Completion providers<br/>[sources.lua]"]
end

node_nvim(("Neovim"))
node_heirline["heirline statusline"]

node_heirline -->|"hosts setup"| node_entry
node_nvim -->|"cmdline activity"| node_entry
node_entry -->|"locates region"| node_positioner
node_entry -->|"displays input"| node_window
node_entry -->|"formats title"| node_shorttext
node_entry -->|"updates menu"| node_completion
node_completion -->|"requests items"| node_sources

click node_entry "https://github.com/zvnoob/heirline-cmdline/blob/main/lua/heirline-cmdline/init.lua"
click node_config "https://github.com/zvnoob/heirline-cmdline/blob/main/lua/heirline-cmdline/config.lua"
click node_positioner "https://github.com/zvnoob/heirline-cmdline/blob/main/lua/heirline-cmdline/positioner.lua"
click node_window "https://github.com/zvnoob/heirline-cmdline/blob/main/lua/heirline-cmdline/window.lua"
click node_shorttext "https://github.com/zvnoob/heirline-cmdline/blob/main/lua/heirline-cmdline/shorttext.lua"
click node_completion "https://github.com/zvnoob/heirline-cmdline/blob/main/lua/heirline-cmdline/completion.lua"
click node_sources "https://github.com/zvnoob/heirline-cmdline/blob/main/lua/heirline-cmdline/sources.lua"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_entry,node_config toneBlue
class node_positioner,node_window,node_shorttext toneAmber
class node_completion,node_sources toneMint
class node_nvim,node_heirline toneIndigo
```

## Components

### Neovim integration

- [Plugin setup and lifecycle](https://github.com/zvnoob/heirline-cmdline/blob/main/lua/heirline-cmdline/init.lua): `lua/heirline-cmdline/init.lua`
- [Configuration](https://github.com/zvnoob/heirline-cmdline/blob/main/lua/heirline-cmdline/config.lua): `lua/heirline-cmdline/config.lua`

### Statusline display

- [Region positioning](https://github.com/zvnoob/heirline-cmdline/blob/main/lua/heirline-cmdline/positioner.lua): `lua/heirline-cmdline/positioner.lua`
- [Floating display](https://github.com/zvnoob/heirline-cmdline/blob/main/lua/heirline-cmdline/window.lua): `lua/heirline-cmdline/window.lua`
- [Title formatting](https://github.com/zvnoob/heirline-cmdline/blob/main/lua/heirline-cmdline/shorttext.lua): `lua/heirline-cmdline/shorttext.lua`

### Completion

- [Completion menu](https://github.com/zvnoob/heirline-cmdline/blob/main/lua/heirline-cmdline/completion.lua): `lua/heirline-cmdline/completion.lua`
- [Completion providers](https://github.com/zvnoob/heirline-cmdline/blob/main/lua/heirline-cmdline/sources.lua): `lua/heirline-cmdline/sources.lua`

### Other components

- **Neovim**
- **heirline statusline**

## Connections

- heirline statusline → Plugin setup and lifecycle: hosts setup
- Neovim → Plugin setup and lifecycle: cmdline activity
- Plugin setup and lifecycle → Region positioning: locates region
- Plugin setup and lifecycle → Floating display: displays input
- Plugin setup and lifecycle → Title formatting: formats title
- Plugin setup and lifecycle → Completion menu: updates menu
- Completion menu → Completion providers: requests items
