Skip to content

Repository files navigation

@nguyenquangthai/pi-omp-theme

npm license

An OMP-inspired visual theme and TUI presentation extension for Pi. It combines Titanium dark/light themes with a coordinated startup view, status line, editor, messages, and tool rendering.

pi-omp-theme surface gallery

Surface gallery

The gallery is more than a logo preview: it shows the surfaces people see in a real Pi session. These representative Pi 0.84.2 captures use the Titanium dark theme, Unicode glyphs, a 120-column terminal, and sample local project data. Click any thumbnail for the full-size image.

Surface What it demonstrates Full-size preview
Welcome Startup resources, tool providers, and recent sessions open welcome.png
Read Quiet, single-line file reads with a readable path open read.png
List Bounded directory output rendered as a tree open list.png
Grep Match counts, file grouping, context, and truncation open grep.png
Tool call Boxed command, response, exit status, and elapsed time open tool-call.png
Status line Model, effort, path, Git state, and context usage open status-line.png
Welcome
Welcome screen with resources, providers, and recent sessions
Read
Compact read tool surface
List
List tool rendered as a bounded tree
Grep
Grep results grouped by file with match context
Tool call
Boxed tool call with output, exit status, and elapsed time
Status line
Responsive status line with model, Git, and context usage

Install it in Pi with one command:

pi install npm:@nguyenquangthai/pi-omp-theme

Features

  • Claude-style and OMP-style editor/status compositions.
  • Responsive status segments for model, effort, path, Git, context, usage, cost, time, and session state.
  • Compact startup header or optional welcome card.
  • Boxed tool rendering, quiet-call batching, adaptive diffs, elapsed time, and completed-turn summaries.
  • Optional message/tool compatibility patches with per-surface identity checks and native fallback.
  • Titanium dark/light themes, Nerd Font/Unicode/ASCII modes, shimmer, syntax-highlight caching, and session accents.

Requirements

  • Node.js 22.19 or newer.
  • Pi 0.83.x or newer. Compatibility patches are probed against the live Pi runtime per surface; Pi version numbers are diagnostic only, so unrelated releases keep the themed TUI when the patched method contracts remain unchanged. Unrecognized contracts fall back to Pi's native rendering.

Install

Use Pi's package manager so the extension and themes are registered correctly:

pi install npm:@nguyenquangthai/pi-omp-theme

Running npm install alone downloads the package but does not register it with Pi.

Verify installation

pi list
pi -p "/pi-omp-theme doctor"

pi list should include npm:@nguyenquangthai/pi-omp-theme. The doctor summary reports the active preset, Pi compatibility identity, surface fallbacks, and host binding; Host binding should read bound. Use /pi-omp-theme doctor json when you need the complete field-level payload.

Install from a local checkout

npm ci && npm run build
pi install /path/to/pi-omp-theme

The compiled entry is dist/extensions/pi-omp-theme.ts on purpose. Pi loads extensions through jiti, which applies the host aliases (@earendil-works/* → the running Pi's own modules) while loading the .ts entry. A .js entry next to a checkout's node_modules/@earendil-works/pi-coding-agent can bind the extension to a second copy of Pi and make message/tool decoration silently miss the TUI. Pi 0.84.3+ runs its Node CLI/RPC entrypoints from a bundled runtime and exposes those host modules virtually; the package detects that loader path instead of comparing it with the modular package entry. If the doctor ever reports hostBinding.status: "foreign", the extension was loaded outside Pi's loader; reinstall with pi install npm:@nguyenquangthai/pi-omp-theme or rebuild the checkout.

The first launch after a rebuild transpiles the bundle once (a few seconds); jiti caches the result for later launches.

Update

pi update npm:@nguyenquangthai/pi-omp-theme
# Or update every installed Pi package:
pi update --extensions

Version-pinned installs such as npm:@nguyenquangthai/pi-omp-theme@1.0.3 remain pinned until explicitly changed.

Uninstall

pi remove npm:@nguyenquangthai/pi-omp-theme

Defaults

The shipped configuration uses the claude preset with a dock editor, a status row below the editor, compact startup presentation, boxed tools, completed-turn summaries, and the titanium theme. Core compatibility patches remain disabled unless explicitly enabled.

Presets

claude, omp, default, minimal, compact, full, ascii, and native.

Configuration

Use the piOmpTheme key in Pi's global or trusted project settings.json:

{
  "piOmpTheme": {
    "preset": "claude",
    "theme": {
      "autoApply": "titanium"
    },
    "compatibility": {
      "allowCorePatches": false
    }
  }
}

Presets coordinate status placement, editor style/frame, separator, and status layout. Keep those fields omitted when you want the preset's complete composition; for example, changing only preset to "omp" selects the rounded border layout. Explicit values still win, but /pi-omp-theme doctor warns when they contradict coordinated preset fields and produce a hybrid UI.

Precedence:

defaults < global settings < trusted project settings < environment < session override

Invalid values fall back safely and appear in /pi-omp-theme doctor.

Read-only tool activation

By default, the theme leaves Pi's active tool set unchanged. This prevents it from re-enabling tools intentionally disabled by extensions such as pi-hashline-edit-pro. Package order is not a workaround you need with this default.

To explicitly add registered grep, find, and ls tools at session start:

{
  "piOmpTheme": {
    "readonlyTools": true
  }
}

Set readonlyTools to false (the default) to leave tool selection alone. Global and trusted-project settings follow the normal configuration precedence. A disabled extension (enabled: false or PI_OMP_THEME_DISABLED=1) never activates tools.

For one invocation, override the setting with an explicit CLI value:

pi --pi-omp-theme-readonly-tools=true
pi --pi-omp-theme-readonly-tools=false

The space-separated forms (--pi-omp-theme-readonly-tools true / false) also work. Migration from 1.0.14: the flag now requires a value; the former bare boolean flag is no longer supported. A value-taking flag avoids Pi 0.99.1 interpreting =false as boolean true. Invalid values disable activation and emit a warning.

Activation is checked at session start, including a new session or Pi's /reload. Editing settings or running /pi-omp-theme reload does not change active tools mid-session. Opting out never removes tools already enabled by you or another extension. Explicit opt-in can still re-enable a tool another extension disabled; leave it off when using replacement tools. Pi's --exclude-tools grep is also available when you need to keep native grep inactive while allowing find and ls.

Environment variables

Variable Purpose
PI_OMP_THEME_DISABLED=1 Disable the extension.
PI_OMP_THEME_NERD_FONTS=1|0 Force Nerd Font or non-Nerd glyphs.
PI_OMP_THEME_EDITOR=native|compact|boxed|dock Override editor style.
PI_OMP_THEME_STATUS=above|below|off Override status placement/state.
PI_OMP_THEME_THEME=<name|off> Select or disable automatic theme application.
PI_OMP_THEME_OSC11=1|0 Override terminal background synchronization.
PI_OMP_THEME_DEBUG=1 Enable bounded diagnostics.

CLI flags

--pi-omp-theme-core-patches
--pi-omp-theme-message-assistant
--pi-omp-theme-message-special-blocks
--pi-omp-theme-tools
--pi-omp-theme-readonly-tools <true|false>
--pi-omp-theme-ascii

Commands

Command Purpose
/pi-omp-theme Show active preset and surface state.
/pi-omp-theme on|off Toggle the extension for the current session.
/pi-omp-theme preset <name> Apply a preset.
/pi-omp-theme placement above|below|border Change status placement.
/pi-omp-theme editor <style> [frame] Change editor presentation.
/pi-omp-theme startup off|compact|overlay Change startup presentation.
/pi-omp-theme surface <name> on|off Toggle a surface.
/pi-omp-theme set <path> <JSON> Set a validated configuration leaf.
/pi-omp-theme persist global|project set <path> <JSON> Persist a validated setting.
/pi-omp-theme reload Reload configuration and affected surfaces.
/pi-omp-theme doctor Show a compact, human-readable health report.
/pi-omp-theme doctor json Show the complete machine-readable diagnostic payload.

Privacy and security

Pi extensions execute with the user's system permissions. Review the source before installation.

The extension does not implement telemetry. The optional welcome presentation reads bounded local Pi metadata; its recent-session list can derive a short display title from the opening request in local session files. That data is rendered locally and is not transmitted by this package.

Development

npm ci
npm run typecheck
npm run depcruise
npm run build
npm run package:smoke
npm run check

npm run check is also enforced by the npm prepack hook.

Releases are published manually to avoid CI billing. The complete maintainer checklist is documented in the release guide.

License

MIT. Required notices from incorporated MIT-licensed sources are retained.

About

OMP-inspired TUI presentation extension and Titanium themes for Pi

Topics

Resources

Security policy

Stars

15 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages