nf-icons 0.1.1

Typed, autocompletable access to every Nerd Fonts glyph — generated from a pinned glyphnames.json snapshot.
Attribute access · exact lookups · fuzzy search · interactive terminal browser.

Installation

pip install nf-icons

Configure a Nerd Font in your terminal to render the glyphs.

Python API

from nerdicons import icons

# Attribute access — fully typed and autocompletable
print(icons.fa.github)
print(icons.md.home.unicode())  # U+F015

# Exact lookup: by canonical name, raw glyph, or codepoint
icon = icons.get("fa-github")
icon = icons["fa-github"]  # subscript is equivalent
icon = icons.from_codepoint("f09b")

# Fuzzy search
results = icons.search("rust", limit=5)

# Membership test
assert "fa-github" in icons

# Iterate all icons
for icon in icons:
    print(icon.namespace, icon.name)

# List available namespaces
print(icons.namespaces())  # ('cod', 'custom', 'dev', ...)

Icon fields

str(icon) returns the glyph. icon.unicode() returns "U+F09B".

IconRegistry (the icons object)

CLI

$ nerdicons search rust
$ nerdicons search rust --limit 5
$ nerdicons search rust --json
$ nerdicons search rust --format "{glyph}  {codepoint}"
$ nerdicons search rust --interactive

$ nerdicons get fa-github
$ nerdicons get fa-github --json

$ nerdicons browse
$ nerdicons browse rust

$ nerdicons copy fa-github

$ nerdicons stats
$ nerdicons doctor
$ nerdicons --version

Interactive browser

browse and search --interactive open a centered terminal UI with no extra dependencies:

Clipboard support uses wl-copy, pbcopy, or xclip — whichever is on PATH. Respects the NO_COLOR environment variable.

Namespaces

Pinned to Nerd Fonts 3.5.0 — 10,995 icons total.

Updating upstream

python generator/generate.py            # regenerate from checked-in snapshot
python generator/generate.py --refresh   # fetch pinned tag first
python generator/generate.py --check     # verify files are current (CI mode)

Change PINNED_VERSION in generator/generate.py to target a new Nerd Fonts release. Review the manifest diff carefully — codepoints can change between releases.

Examples

Runnable examples in examples/:

python examples/basic.py
python examples/lookup.py

Contributing

See CONTRIBUTING.md. Quick start:

python -m venv .venv && source .venv/bin/activate
pip install -e '.[dev]'
ruff format . && ruff check . && mypy src generator tests && pyright && pytest