logicsrc/docs/openicon.md

OpenIcon

OpenIcon is an icon set as a folder: one openicon.json at the top that names every icon, says where its files are and who or what drew it, and gives each icon three terminal glyphs, so the same mail icon is an SVG in a browser, a PNG in an email, 󰇰 in a terminal with a Nerd Font, ✉ in one without, and @ over a serial line. It is maintained by Profullstack, Inc. as part of the LogicSRC open-standards surface.

Status: 0.1. A sibling of OpenEmoji: files first, one small descriptor, made_by on the work.

Slug: openicon

The problem

Every interface needs the same few hundred icons: mail, phone, link, search, settings, a trash can, a GitHub logo. Every icon set ships them under its own names (Lucide's mail is Font Awesome's envelope is Material's email), in its own folder layout, with its licence in a README, and with brand logos mixed in beside drawn icons as if a trademark were just another shape.

Terminals are worse. A TUI that wants an icon has three choices, all bad: hard-code a Nerd Font codepoint and show a box on every terminal without one, hard-code an emoji and break the column width, or draw nothing. No icon set says what an icon should be when there are no pixels at all.

The shape

openicon.json          the descriptor (rule 1)
svg/<key>.svg          24x24, currentColor
png/<size>/<key>.png   rendered from the SVG
sprite.svg             every icon as a <symbol>, optional

{
  "openicon": "0.1",
  "name": "OpenIcon",
  "version": "2026-09-24",
  "license": "MIT",
  "made_by": "ai",
  "disclosure": "ai-generated",
  "ai_model": "claude-opus-5-5",
  "ai_provider": "Anthropic",
  "grid": { "size": 24, "stroke": 2, "padding": 2 },
  "sizes": [16, 20, 24, 32, 48, 64, 128, 256],
  "sprite": "sprite.svg",
  "icons": [
    {
      "key": "mail",
      "name": "Mail",
      "category": "communication",
      "aliases": ["email", "envelope"],
      "keywords": ["message", "inbox"],
      "svg": "svg/mail.svg",
      "png": "png/{size}/mail.png",
      "tui": { "nerd": "󰇰", "nerd_code": "f01f0", "nerd_name": "md-email_outline", "unicode": "✉", "ascii": "@" }
    },
    {
      "key": "github",
      "name": "GitHub",
      "category": "brand",
      "brand": true,
      "trademark": "GitHub and its logo are trademarks of their owner. Use them to refer to GitHub, not to imply endorsement.",
      "source": "simple-icons:github",
      "license": "CC0-1.0",
      "made_by": "human",
      "svg": "svg/github.svg",
      "png": "png/{size}/github.png",
      "tui": { "nerd": "󰊤", "nerd_code": "f02a4", "nerd_name": "md-github", "unicode": "🐙", "ascii": "gh" }
    }
  ]
}

Two entries from the reference set: a drawn icon and a brand logo.

The rules

There are eight, and every one of them degrades rather than fails.

1. A set is a folder with openicon.json at its root. Every path is relative to that file. Top-level keys a reader should understand: openicon (the spec version, required), name (required), version, license (SPDX, covering every icon without its own), homepage, grid, sizes, sprite and icons (required). Unknown keys are kept and ignored.

2. An icon's key is its name, in kebab case. Lowercase letters and digits joined by single hyphens: mail, git-pull-request, arrow-up-right. The key is also the file name. A brand's key is the brand's own name in the same form (github, stack-overflow), never a product code.

3. Aliases find one icon; keywords find many. aliases are other names people type for the icon (email for mail, trash for delete), and every key and alias in a set is unique, so icon('email') is never ambiguous. keywords are search terms and may be shared (money finds wallet, dollar and coins). A reader resolves a name against keys first, then aliases.

4. Files are monochrome and take the text colour. An SVG uses currentColor for every stroke and fill and a 0 0 24 24 view box. grid states the drawing rules the set keeps (size, stroke width, padding), so a reader mixing sets can scale one to match another. png may contain {size}, filled from sizes; PNGs are rendered in one colour, which the set's README states. A set without PNGs or without a sprite is still a set.

5. Every icon has terminal glyphs. tui.unicode is one character or emoji that says the same thing, and tui.ascii is 1 to 4 printable ASCII characters, spaces only inside ([ ], >_, @). tui.nerd is the Nerd Font character when there is one, with nerd_code (hex) and nerd_name (the Nerd Fonts glyph name, without nf-), so a reader can check it against the Nerd Fonts release it has. An icon with no Nerd Font glyph leaves the three nerd fields out.

6. A terminal picks the best glyph it can draw. Nerd first, then Unicode, then ASCII. A Nerd Font cannot be detected from inside a terminal, so a reader takes it from configuration: OPENICON_GLYPHS=nerd|unicode|ascii wins, NERD_FONT=1 means nerd, a UTF-8 locale means unicode, anything else means ascii. A reader that reserves a fixed cell width pads to it, because an emoji may be two columns wide where a Nerd glyph is one.

7. A brand says it is one. A logo carries brand: true, a trademark note, its source (simple-icons:<slug>, font-awesome:<name>, or a URL) and its own license, because the licence of a drawing is not permission to use a mark. Brand logos are taken from their owners or from a set that publishes them; a set does not redraw them.

8. The set says what made it. made_by is human, ai or both, the OpenWebring vocabulary, and disclosure, ai_model, ai_provider and ai_prompt_url are the W3C AI Content Disclosure vocabulary, as in OpenEmoji. Any of them may be repeated on an icon that differs from the set: in the reference set the drawn icons are ai and every brand logo is human.

Discovery

• A <link rel="openicon" href="/icons/openicon.json"> in a page's head: this page draws its icons from that set.
• /.well-known/openicon.json on a site: a set, or a list of sets, {"openicon": "0.1", "sets": [{"name": "…", "url": "…/openicon.json"}]}.
• A package: a set published to npm, PyPI or a git repository keeps openicon.json at the package root. Served as JSON with CORS open.

Mapping from what exists

OpenIcon	Lucide	Tabler	Font Awesome	Nerd Fonts	Simple Icons
key	icon name	icon name	icon name	glyph name after the prefix	slug
aliases	aliases in the icon's JSON	none	aliases.names	none	aliases.aka
keywords	tags	tags	search.terms	none	none
category	categories	category	categories	the font the glyph came from	none
grid	24, stroke 2	24, stroke 2	512 tall, filled	a font cell	24, filled
tui.nerd	none	none	the codepoint, in a patched font	the codepoint	none
brand	none (no brands)	a few, unmarked	the brands style	some, unmarked	every icon
license per icon	none	none	per style	none	one for all (CC0)

An importer from any of these is a rename and a copy. Only tui.unicode and tui.ascii need a person or a model to write them, because none of the sets carries them.

What is deliberately absent

• No colour. Icons are monochrome and take the text colour. A brand's own colour is the brand's business; a set may add hex to a brand entry and a reader may ignore it.
• No style variants. Outline, filled and duotone versions of one icon are three sets, or three icons with three keys. One key, one drawing.
• No icon font format. A webfont is a build output a set may ship, not part of the spec; the SVGs and the tui glyphs are the interchange.
• No registry of names. Keys are the set's own. Aliases are how one set answers to another's names.
• No animation. A spinner is a component, not an icon.

Reference implementation

The reference set is profullstack/openicon: 370 icons, 259 drawn on a 24x24 grid with 2px strokes and 111 brand logos from Simple Icons and Font Awesome Free. 357 of them have a Nerd Font glyph. It is built by icon in profullstack/cli-tools:

icon build --out ./openicon   # openicon.json, svg/, png/, sprite.svg
icon glyph mail               # 󰇰, ✉ or @, whichever this terminal can draw

hqtui ships the set as its default icon pack, so icon('mail') in a TUI draws the best glyph the terminal has.

Related: OpenEmoji for the sibling format; OpenWebring for made_by.