mcpField
I
iconify-skill

iconify-skill

github.com/bingal设计与 UI471 次安装27 周前更新
代码仓库

关于 iconify-skill

iconify-skill 是一个用于搜索、推荐和获取 SVG 图标的 Python 命令行技能，结合精选图标集的离线索引与在线搜索和获取功能。

主要功能

  1. 01离线及在线搜索图标
  2. 02按意图推荐图标
  3. 03获取自定义样式的 SVG
  4. 04列出图标集
  5. 05检查环境和索引
  6. 06查看署名信息

适用场景

  1. 01查找界面元素图标
  2. 02为功能构想探索图标
  3. 03获取自定义样式的 SVG

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/bingal/iconify-skill --skill iconify-skill

安装后在 Claude Code 中输入/iconify-skill确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

AGENTS.md
.gitattributes
LICENSE
pyproject.toml
pytest.ini
assets/
intent_keywords.json
curated_sets.txt
data/
collections.json
references/
LICENSES_AND_ATTRIBUTION.md
REFERENCE.md
scripts/
build_index.py
update_bundled_data.py
doctor.py
iconify_cli.py
tests/
test_iconify.py
__init__.py

详细介绍

Iconify Skill

使用 scripts/iconify_cli.py 中的 CLI 搜索、推荐和获取 SVG 图标。

快速开始

  1. 确保 Python 3 可用。
  2. 运行 doctor 验证环境。
  3. 如果缺少离线索引，请构建索引。
python3 $SKILL_DIR/scripts/iconify_cli.py doctor

python3 $SKILL_DIR/scripts/iconify_cli.py build-index

命令接口

python3 $SKILL_DIR/scripts/iconify_cli.py <command> [arguments]

常用命令

  • list-collections - 列出图标集
  • search <query> - 搜索图标（离线精选索引 + 在线回退）
  • get <prefix:name> - 获取 SVG（需要网络）
  • suggest "<intent>" - 根据意图推荐图标
  • attribution - 显示许可证信息
  • doctor - 系统健康检查

使用示例

# Search icons (offline)
python3 $SKILL_DIR/scripts/iconify_cli.py search "close button" --limit 5

# Get SVG with custom styling
python3 $SKILL_DIR/scripts/iconify_cli.py get mdi:home --size 24 --color "#3B82F6"

# Suggest icons for a feature
python3 $SKILL_DIR/scripts/iconify_cli.py suggest "user profile page"

# Filter by collection
python3 $SKILL_DIR/scripts/iconify_cli.py search "home" --prefixes lucide,heroicons

离线与数据说明

  • search 使用内置的 SQLite 索引搜索精选图标集（约 32K 个图标），并会自动回退到 Iconify 在线搜索 API，以扩大搜索范围。
  • get 需要网络访问权限（Iconify API / GitHub raw JSON）。
  • 使用 doctor 确认缓存和索引是否可用。
  • 如有需要，使用 build-index 重新生成搜索索引。

内置图标集（约 32K 个图标）

mdi、ph、tabler、simple-icons、lucide、bi、heroicons、feather、radix-icons

这些采用 MIT/ISC 许可证的精选图标集已内置，可供快速离线搜索。此列表以外的搜索结果将通过 Iconify 在线搜索 API 获取。

输出格式

退出代码
  • 0 - 成功
  • 1 - 未找到图标 / 参数无效
  • 2 - 网络错误（get 命令）
  • 3 - 数据库错误（离线模式）
SVG 输出
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="24" height="24">
  <path fill="#3B82F6" d="..."/>
</svg>

参考资料

  • 阅读 references/REFERENCE.md，了解架构详情、CLI 行为、缓存路径和错误处理。
  • 需要了解许可证要求时，请阅读 references/LICENSES_AND_ATTRIBUTION.md。

评论

支持 Markdown