agentleFS
Mark-LifeMark-Life/peektrace/.agents/skills/opentui/SKILL.md

opentui

Skill4 starsChanged 3 months agoMITView on GitHub

Build terminal UIs with OpenTUI. Covers core, components, audio, keymaps, React, Solid, plugins, testing, standalone executables, QR encoding, SSH, and Three.js WebGPU.

We split this skill into the rules it gives an agent

3 rules. 0 are common, 1 is distinctive, and 2 are very specific to this project.

  • 0

    Common

    Most of the 11 edited versions we read keep these.

  • 1

    Distinctive

    This author's own choices. Worth a look.

  • 2

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Prefer the current entry pages first, then read narrower docs in the same section.

    line 84
  2. Very specific:

    Read the sibling docs//*.mdx files directly instead of copying prose into this file.

    line 85
  3. Very specific:

    Use stable /docs/... URLs when cross-referencing docs.

    line 86

“Common” is measured: kept by at least 6 in 10 of the 11 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

OpenTUI Skill

Canonical reference docs are authored once in sibling docs/**/*.mdx files.

Inside the OpenTUI repo, this skill root lives at packages/web/src/content/, so the same files are also visible at packages/web/src/content/docs/**/*.mdx.

Path invariant

  • /docs/<slug> maps to docs/<slug>.mdx relative to this skill root
  • in the repo, that same slug maps to packages/web/src/content/docs/<slug>.mdx

Reading order by area

  • Getting started: /docs/getting-started
  • Core: /docs/core-concepts/renderer
  • Testing: /docs/core-concepts/testing
  • Audio: /docs/core-concepts/audio
  • Keymap: /docs/keymap/overview
  • React: /docs/bindings/react
  • Solid: /docs/bindings/solid
  • Components: /docs/components/text, /docs/components/input
  • Layout: /docs/core-concepts/layout
  • Keyboard: /docs/core-concepts/keyboard
  • Plugins: /docs/plugins/slots
  • Runtime and packaging: /docs/reference/env-vars, /docs/reference/standalone-executables
  • Package entrypoints: /docs/reference/package-entrypoints
  • QR encoding: /docs/reference/qr-encoder
  • SSH: /docs/reference/ssh
  • Three.js WebGPU: /docs/reference/three

Quick routing by intent

Intent(s)Start here
getting-started, installation, quickstart, introdocs/getting-started.mdx
core, renderer, terminal, scrollback, lifecycledocs/core-concepts/renderer.mdx
audio, native-audio, sound, playback, streaming, radio, mp3, flac, pcm, fftdocs/core-concepts/audio.mdx
keymap, keybindings, shortcuts, commands, leader, ex-commandsdocs/keymap/overview.mdx
layout, flexbox, yoga, positioningdocs/core-concepts/layout.mdx
keyboard, input, keybindings, paste, focusdocs/core-concepts/keyboard.mdx
testing, test-renderer, snapshots, framesdocs/core-concepts/testing.mdx
react, jsx, hooks, keyboard, paste, focus, blur, selection, animation, testingdocs/bindings/react.mdx
solid, jsx, signals, hooks, keyboard, animation, testingdocs/bindings/solid.mdx
plugins, plugin, slots, registry, extensionsdocs/plugins/slots.mdx
text, styling, content, selectiondocs/components/text.mdx
input, form, editing, focusdocs/components/input.mdx
env, environment, configuration, flagsdocs/reference/env-vars.mdx
standalone, executable, bun-compile, node-sea, node-assetsdocs/reference/standalone-executables.mdx
package-exports, entrypoints, subpath-exports, importsdocs/reference/package-entrypoints.mdx
qr, qrcode, qr-encoder, svg-qr, gs1, eci, structured-appenddocs/reference/qr-encoder.mdx
ssh, remote-tui, ssh-server, authentication, middlewaredocs/reference/ssh.mdx
three, threejs, webgpu, 3d, sprites, physicsdocs/reference/three.mdx

For concrete component requests, jump straight to docs/components/<name>.mdx after the relevant entry page. For plugin implementation details, narrow from docs/plugins/slots.mdx into docs/plugins/core.mdx, docs/plugins/react.mdx, or docs/plugins/solid.mdx.

Current skill entry pages

  • docs/getting-started.mdx
  • docs/core-concepts/renderer.mdx
  • docs/core-concepts/audio.mdx
  • docs/core-concepts/testing.mdx
  • docs/keymap/overview.mdx
  • docs/core-concepts/layout.mdx
  • docs/core-concepts/keyboard.mdx
  • docs/bindings/react.mdx
  • docs/bindings/solid.mdx
  • docs/plugins/slots.mdx
  • docs/components/text.mdx
  • docs/components/input.mdx
  • docs/reference/env-vars.mdx
  • docs/reference/standalone-executables.mdx
  • docs/reference/package-entrypoints.mdx
  • docs/reference/qr-encoder.mdx
  • docs/reference/ssh.mdx
  • docs/reference/three.mdx

Working rules

  • Prefer the current entry pages first, then read narrower docs in the same section.
  • Read the sibling docs/**/*.mdx files directly instead of copying prose into this file.
  • Use stable /docs/... URLs when cross-referencing docs.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.