# Phosphor Icons CLI

CLI and agent skill for [Phosphor Icons](https://phosphoricons.com) — search, export SVG/PNG assets, and get framework guidance.

> Community project, not affiliated with the official Phosphor Icons project. See [phosphor-icons/core](https://github.com/phosphor-icons/core).

## Install

```bash
npm install phosphor-icons
```

From source:

```bash
git clone https://github.com/lasaths/phosphor-icons.git
cd phosphor-icons
npm install
npm run build
```

## CLI

```bash
phosphor-icons icon heart --weight bold --color "#ef4444" --size 32 --out heart.svg
phosphor-icons icon house user gear --format png --size 24 --dir ./icons
phosphor-icons search arrow --limit 5
phosphor-icons categories
phosphor-icons skill path
```

| Command | Description |
|---------|-------------|
| `icon <name...>` | Export one or more icons as SVG or PNG |
| `search <query>` | Search icon names and bundled metadata |
| `categories` | List bundled categories and examples |
| `skill path` | Print the bundled skill directory |

Flags for `icon`: `--weight/-w`, `--color/-c`, `--size/-s`, `--format/-f`, `--out/-o`, `--dir/-d`, `--quiet/-q`

Icons load from `@phosphor-icons/core` locally first, then fall back to GitHub raw assets.

## Agent skill

Bundled at `skills/phosphor-icons/SKILL.md`.

```bash
phosphor-icons skill path
npx skills add lasaths/phosphor-icons --skill phosphor-icons --agent codex -y
```

## Development

```bash
npm install
npm run build
npm test
```

## License

MIT. Phosphor Icons are MIT licensed.