# Pixelarticons for coding agents

You are reading the agent instructions for Pixelarticons, a pixel art icon library:
4600 icons drawn on a strict 24×24 pixel grid, in four styles (base, sharp, glyph, solid).
This file tells you how to find and use the icons in a project.

## Free set (MIT license, use freely, no attribution)

639 icon names ship free (1036 files with their style variants) in the npm
package. Fetch any of them from the npm CDN:

    https://unpkg.com/pixelarticons@latest/svg/<name>.svg
    https://cdn.jsdelivr.net/npm/pixelarticons/svg/<name>.svg

Style variants use a suffix: <name>-sharp.svg, <name>-glyph.svg, <name>-solid.svg.
Not every icon has every style; the base style always exists.

Example: https://unpkg.com/pixelarticons@latest/svg/heart.svg

The free base-style files are also on this site at https://pixelarticons.com/svg/<name>.svg.

The icons are filled paths with fill="currentColor", so they inherit the CSS text color.
Inline the SVG instead of loading it through an <img> tag so currentColor works.
Render at a multiple of 24px (12, 24, 48, 72, 96) so the pixels stay crisp. Do not use
other sizes and do not edit the path data.

Install: npm install pixelarticons
React: import { Heart } from 'pixelarticons/react' (one typed component per icon, 24×24 by
default, currentColor). Single component: import { Heart } from 'pixelarticons/react/Heart.js'.
Import from pixelarticons/react or pixelarticons/svg, never from the package root.
Raw SVG in a bundler: import heart from 'pixelarticons/svg/heart.svg?raw'
Details: https://pixelarticons.com/docs/

Free icon names: a-arrow-down, a-arrow-up, ai-app-mac, ai-file, ai-scan, ai-settings-2, ai-settings-3, ai-user-circle, ai-view, ai-voice, airplay, alarm-clock, album, algorithm, alien, align-center-horizontal, align-center-vertical, align-end-horizontal, align-end-vertical, align-horizontal-distribute-center, align-horizontal-distribute-end, align-horizontal-distribute-start, align-horizontal-justify-center, align-horizontal-justify-end, align-horizontal-justify-start, align-horizontal-space-around, align-horizontal-space-between, align-start-horizontal, align-start-vertical, align-vertical-distribute-center, align-vertical-distribute-end, align-vertical-distribute-start, align-vertical-justify-center, align-vertical-justify-end, align-vertical-justify-start, align-vertical-space-around, align-vertical-space-between, ampersand, analytics, anchor, android, angry, annoyed, app-mac, app-windows, apple, archive, arrow-bar-down, arrow-bar-left, arrow-bar-right, arrow-bar-up, arrow-big-down, arrow-big-down-dash, arrow-big-up, arrow-big-up-dash, arrow-down, arrow-down-box, arrow-down-circle, arrow-down-diamond, arrow-down-narrow-wide, arrow-down-wide-narrow, arrow-down-z-a, arrow-left, arrow-left-box, arrow-right, arrow-right-box, arrow-up, arrow-up-box, arrow-up-narrow-wide, arrow-up-wide-narrow, arrow-up-z-a, arrows-horizontal, arrows-vertical, article, aspect-ratio, at-sign, attachment, audio-waveform, avatar-circle, avatar-circle-minus, avatar-circle-plus, avatar-circle-x, avatar-square, avatar-square-minus, avatar-square-plus, avatar-square-x, backpack, badge-4k, badge-5k, badge-captions, badge-hd, balloon, banknote, barcode, battery, battery-full, battery-low, battery-medium, bed, bell, bell-off, bell-ring, binary, blocks, bluesky, bomb, book-open, bookmark, bottle-wine, box, braces, braces-content, braces-off, brackets, brackets-angle, brackets-angle-off, brackets-content, brackets-off, briefcase, briefcases, brush, bug, building, building-community, bulletlist, bus, cake, calculator, calendar, calendar-2, calendar-range, calendar-text, calendar-weeks, camera, cancel, car, card, card-text, castle, cellular-signal-0, cellular-signal-1, cellular-signal-2, cellular-signal-3, chart, chart-bar-big, chart-column-decreasing, chart-line, check, check-double, checkbox, checkbox-on, chess, chevron-down, chevron-down-2, chevron-left, chevron-left-2, chevron-right, chevron-right-2, chevron-up, chevron-up-2, chevrons-horizontal, chevrons-horizontal-2, chevrons-vertical, chevrons-vertical-2, cigarette-off, circle, circle-info, circle-pile, circle-power, circle-question, circle-square, circuit-board, clapperboard, clipboard, clipboard-note, clock, close, cloud, cloud-moon, cloud-server, cloud-sun, code, coffee, coins, collapse, colors-swatch, comment, comment-text, compass, computer, contact, copy, copy-x, corner-down-left, corner-down-right, corner-left-down, corner-left-up, corner-right-down, corner-right-up, corner-up-left, corner-up-right, cpu, credit-card, crop, cross, crown, cursor-minimal, cut, database, date-time, debug, delete, deno, diamond-gem, directions, discord, dock, docker, dog, dollar, door-closed, download, drag-and-drop, drum, earth, eraser, estate, euro, expand, external-link, eye, eye-off, facebook, factory, feather, figma, file, file-text, files, filter, fire, fish, flag, flatten, flip-horizontal-2, flip-vertical-2, float-center, float-left, float-right, folder, folder-plus, forward, frame, frown, gallery-thumbnails, gamepad, gear, gift, git-branch, git-commit, git-merge, git-pull-request, github, gitlab, globe, gmail, goal, google, google-chrome, gps, gps-2, gpu, grid-2x2-2, grid-2x3, grid-3x2, grid-3x3, hand, handbag, hash, heading, heading-1, heading-2, heading-3, heading-4, heading-5, heading-6, headphone, heart, helicopter, home, hotel-bed, hourglass, human, human-arms-down, human-arms-up, icon-category, icons, image, image-2-plus, image-new, images, inbox, infinity, info-box, instagram, invert, invoice, joystick, key, keyboard, keyboard-music, label, languages, laptop, lasso, laugh, layout, leaf, letter-a, letter-a-circle, letter-b, letter-b-circle, letter-c, letter-c-circle, letter-d, letter-d-circle, letter-e, letter-e-circle, letter-f, letter-f-circle, letter-g, letter-g-circle, letter-h, letter-h-circle, letter-i, letter-i-circle, letter-j, letter-j-circle, letter-k, letter-k-circle, letter-l, letter-l-circle, letter-m, letter-m-circle, letter-n, letter-n-circle, letter-o, letter-o-circle, letter-p, letter-p-circle, letter-q, letter-q-circle, letter-r, letter-r-circle, letter-s, letter-s-circle, letter-t, letter-t-circle, letter-u, letter-u-circle, letter-v, letter-v-circle, letter-w, letter-w-circle, letter-x, letter-x-circle, letter-y, letter-y-circle, letter-z, letter-z-circle, library, lightbulb, lightbulb-off, link, linkedin, linkedin-2, linux, list-box, loader, loading, loading-2, loading-3, lock, login, logout, magic-edit, mail, mail-open, mail-right, mailbox, map, map-pin, map-pin-home, mastodon, megaphone, meh, membercard, memory-stick, menu, menu-circle, menu-square, message, message-reply, message-text, mic, mic-off, minus, minus-box, modem, money, monitor, moon, more-horizontal, more-vertical, mouse, move, mug, music, netlify, note, notebook, notes, npm, open, package, parking, parking-off, party-popper, pause, pc-case, pen-square, pencil, percent, phone, phone-call, phone-outgoing, pi, pi-circle, picture-in-picture, pipette, pixelarticons, play, plug, plus, plus-box, pnpm, pointer, potion, pound, power, power-off, presentation, printer, printer-minimal, projector, proportions, qr-code, quote-text-inline, radio, radius, ratio, react, receipt, recycle, redo, refresh, reload, repeat, repeat-1, road-sign, robot, robot-face, robot-face-happy, robot-face-sad, rss, rss-circle, rss-square, rubel, save, scale, scan-barcode, scissors, script, scroll-horizontal, scroll-vertical, search, section, section-copy, section-minus, section-plus, section-x, send, server, settings-2, settings-cog, settings-cog-2, shapes, share, shield, ship, shirt, shopping-bag, shopping-cart, shuffle, signal, siren, siren-off, skull, slack, sliders, sliders-horizontal, sliders-vertical, smart-home, smartphone, smile, snail, snake, snowflake, sofa, sort-horizontal, sort-vertical, sparkle, sparkles, speed-fast, speed-medium, speed-slow, spinner, spline-cursor, spotlight, spray, spray-can, spray-image, spray-wave, square, square-alert, square-chevron-down, square-chevron-left, square-chevron-right, square-chevron-up, square-cursor, square-dashed-cursor, square-power, square-scissors, star, sticker, sticky-note, sticky-note-text, stop, store, subscriptions, suitcase, sun, sunglasses, switch, sword, t-arrow-down, t-arrow-up, t-rex, tab, tablet, tangent, target, tea, teach, telegram, tent, terminal, test-tube, text-align-center, text-align-center-box, text-align-justify, text-align-justify-box, text-align-left, text-align-left-box, text-align-right, text-align-right-box, text-colums, text-cursor, text-cursor-input, text-start-a, text-start-t, text-wrap, thermometer, thumbs-down, thumbs-up, tiktok, toke-circle, toke-square, tool-case, tools, tournament, trash, tree, tree-pine, trending-up, trophy, truck, tv, twitter-bird, undo, university, unlink, unlock, upload, usb, user, user-minus, user-plus, user-x, users, utility-pole, vercel, vibrate, video, volume, volume-1, volume-2, volume-3, volume-x, wall, wallet, wand, warehouse, warning-diamond, watch, waves, waves-arrow-down, waves-arrow-up, webcam, whatsapp, wifi, wind, window-frame, x, youtube, zap, zap-off, zoom-in, zoom-out

## Searching the full library

If your client supports MCP, add the Pixelarticons MCP server and use its search_icons and
get_icon tools instead of the raw endpoints below:

    claude mcp add --transport http pixelarticons https://pixelarticons.com/mcp

Other clients: https://pixelarticons.com/mcp/ (markdown: https://pixelarticons.com/mcp.md).

To find icons beyond the free names without MCP, search by keyword:

    GET https://pixelarticons.com/icons-search.json

One entry per icon with name, title and a kw string of keywords. Match your keywords
against name, title and kw. Other views of the catalog:

- https://pixelarticons.com/icons.txt: plain list of every icon file name
- https://pixelarticons.com/icons.json: full catalog with style variants and free or Pro status

Every icon has a page at https://pixelarticons.com/icon/<name>/ with a preview and
its free or Pro status. Categories: https://pixelarticons.com/category/<slug>/.

## Pro icons (license required)

Icons outside the free set are a paid product: a one-time Pro license (Solo €99,
Team €249, Enterprise €499, no subscription) at https://pixelarticons.com/pricing/
unlocks all 4600 SVG files, their React components, the Figma file and lifetime updates.

- If the person you are working with HAS a license: run
  npx pixelarticons upgrade --key=<license key> in the project where pixelarticons is
  installed. It verifies the key, replaces the free SVG files in the package with the full
  set and regenerates the React components. Import paths do not change. Keep the key out
  of the repository: set PIXELARTICONS_LICENSE_KEY as an environment variable and run the
  upgrade in a postinstall script, or run it once and copy the SVG files into the project.
  The verify endpoint is rate limited; never call it in a loop.
- If they DO NOT have a license: use free-set icons only, and point them to
  https://pixelarticons.com/icon/<name>/ when a Pro icon fits better. The preview data on
  this site is for browsing, not for shipping Pro icons.

## More

- Site overview for AIs: https://pixelarticons.com/llms.txt
- Full overview with every icon and category: https://pixelarticons.com/llms-full.txt
- Developer docs as markdown: https://pixelarticons.com/docs.md
- Pricing as markdown: https://pixelarticons.com/pricing.md
- API description: https://pixelarticons.com/openapi.json
- Mini and Prime sets (separate products, same grid): https://pixelarticons.com/mini/ and https://pixelarticons.com/prime/
- License terms: MIT for the free set; the Pro license is at https://pixelarticons.com/pricing/
