Getting started · 源码安装

向智能体
提供简报。
保留校样。

IconFlow 将产品意图转化为可编辑的 SVG,并在交付任何资产前,确保设计能够经受住原生像素、平台裁切以及绑定源文件的审查。

  • Python 3.10+
  • Git
  • 单次网络配置
智能体交接01 / 04
产品意图

帮助人们对比研究内容且不迷失脉络。

本质 · 校样避免 · 闪光
决策始终可供查验简报 · SVG · 审查 · receipt(凭证) · 案例

运作模式

智能体负责设计。
IconFlow 负责求证。

智能体深入研究产品、探索各具特色的概念方案,并编写语义化 SVG。IconFlow 则提供设计指南、确定性渲染器、质量关卡、目标格式转换以及学习闭环。它不是一个“提示词生图”生成器。

选择你的路径

两扇大门。
同一个质量关卡。

当你需要在产品构思与 SVG 工艺上获得协助时,使用智能体路径;当你已经完全掌握设计决策时,使用 CLI 路径。两条路径最终都落实于相同的审查契约。

推荐智能体辅助

描述产品要解决的问题,而非具体的画面。

安装开放格式的 IconFlow Skill。当你需要应用图标、favicon、品牌标识或系统托盘图标时,兼容的智能体即可自动发现该工作流。

  1. 01一次性安装 Skill
  2. 02向智能体提供产品上下文
  3. 03查验方案比选与 Review Lab
使用智能体简报
透明直接 CLI

亲自掌控每一个决策。

阅读设计指南,编写 SVG 决选方案,并运行与智能体相同的命令。CLI 背后没有任何隐藏服务。

  1. 01创建 iconflow.toml
  2. 02对比并审查候选方案
  3. 03仅在获得当前有效批准时交付
查看全部命令

正在使用其他 AI 智能体? 任何能够读取仓库指令并运行 Shell 命令的智能体,都可以通过 AGENTS.md 配合 CLI 来使用 IconFlow。Skill 的自动发现功能取决于客户端支持情况。

5 分钟引擎校样

在开始设计前,
先验证流水线。

这会将 IconFlow 仓库中已签入且通过审查的图标家族构建到临时工作目录中。它验证的是你的运行环境——而非证明可以在 5 分钟内设计出一套独具特色的全新标识。

01克隆获取当前源码。
02配置安装 Python 依赖、Chromium 以及智能体 Skill。
03交付校样重新验证 receipt 并构建 23 项资产。

Windows · PowerShell

git clone https://github.com/snowyukitty/ai-iconflow.git
cd ai-iconflow
python -m venv .venv
powershell -NoProfile -ExecutionPolicy Bypass -File .\scripts\setup.ps1
.\.venv\Scripts\python.exe -m iconflow doctor
.\.venv\Scripts\python.exe -m iconflow ship `
  --config brand\iconflow.toml `
  --review brand\master-review.json `
  --out work\quick-start\icon-out

macOS / Linux · shell

git clone https://github.com/snowyukitty/ai-iconflow.git
cd ai-iconflow
python3 -m venv .venv
sh ./scripts/setup.sh
./.venv/bin/python -m iconflow doctor
./.venv/bin/python -m iconflow ship \
  --config brand/iconflow.toml \
  --review brand/master-review.json \
  --out work/quick-start/icon-out
IconFlow 标志
预期结果

一道关卡,而非仅仅一个文件夹。

doctor报告渲染器已就绪。ship 验证已签入的源文件与审查契约,重新执行 QA,并在 work/quick-start/icon-out/ 目录下写入 Web、PWA、Tauri 桌面端、Electron 以及系统托盘资产。

  • 源文件哈希匹配
  • 0 条自动化警告
  • 6 项评分 ≥ 4/5

从意图出发

向智能体提供
一份实用的简报。

仅有名词的提示词只能产生装饰图案。请明确产品职责、目标受众、个性特质、配色方案、需避免的陈词滥调,以及确切的输出版面。

简报 / 01智能体所需信息
产品意图
产品赋能用户实现什么?
用户任务
用户正在取得怎样的进展?
本质
指导每项选择的一个核心词。
个性特质
两到三个互具张力的特质。
陈词滥调
应当弃用的显见品类符号。
目标平台
Web、PWA、桌面端、系统托盘——或者仅限实际存在的平台。

智能体提示词

Use the IconFlow skill to design, review, and ship a distinctive icon family for this project.

Product intent: [what the product enables]
User job: [the progress a person wants]
Essence: [one word]
Personality: [two or three traits]
Existing palette: [tokens or colors]
Clichés to avoid: [obvious symbols]
Targets: [web, pwa, tauri, electron, tray]

Keep the editable SVG and iconflow.toml in this project. Show me the concept bake-off and native-size review before shipping. Do not stop before recording the case.

通用兜底方案

不支持 Skill 自动发现?直接向智能体提供契约。

即使客户端不支持 Agent Skills,只要智能体能够读取文件并执行本地 Python CLI,该方案同样适用。

Read [ICONFLOW_REPO]/AGENTS.md completely.
Use [ICONFLOW_REPO]/.venv/.../python -m iconflow ...
Keep your shell in this consuming project.
Follow concept → compare → check → review → ship → case.

完整闭环

每条命令
都不可或缺。

请在接入项目的根目录下运行这些命令。通过绝对路径调用 IconFlow 虚拟环境中的 Python,确保配置与最终源文件始终保存在其所属的产品仓库中。

  1. 01
    简报

    编写产品契约。

    在动笔绘制前记录意图。配置文件还会固定目标平台、色彩、路径以及系统托盘行为。

    python -m iconflow init --out iconflow.toml \
      --name "My App" --essence proof \
      --targets web,tauri,electron,tray
  2. 02
    探索

    强制发散不同的视觉构想。

    从不同视角至少构思 4 个概念方案。技法预设只是辅助搭建的脚手架,绝不是成型的最终标识。

    python -m iconflow styles
    python -m iconflow new flat-geometric \
      --out work/my-app/a.svg
  3. 03
    对比

    先定形体,再做打磨。

    将 2 到 3 个决选方案拼版比对。在 128px、16px 以及剪影状态下查验图版。

    python -m iconflow compare \
      work/my-app/a.svg work/my-app/b.svg \
      work/my-app/c.svg --out work/my-app/bake.png
  4. 04
    检验

    审查真实的目标平台转换。

    修复所有警告。随后检查原生像素、Alpha 通道、自适应裁切、桌面端圆角以及系统托盘呈现效果。

    python -m iconflow check master.svg
    python -m iconflow review --config iconflow.toml \
      --out work/my-app/review.png \
      --html work/my-app/review.html
  5. 05
    交付

    让批准做到失败即阻断。

    仅在每个评分轴均达到 4/5 时才导出 Review Lab 的 receipt。源文件或目标平台的任何变动都会使该 receipt 作废。

    python -m iconflow ship \
      --config iconflow.toml \
      --review master-review.json
  6. 06
    学习

    将经验沉淀回系统。

    记录最初失败的原因、所做的修改以及一条可复用的规则。未经记录沉淀的图标无法带来任何经验。

    python -m iconflow case new ...
    python -m iconflow case lint
    python -m iconflow case stats

精准的输出图标家族

仅索取
实际交付的版面。

目标平台必须明确指定。IconFlow 不会宣称支持“所有平台”,完整的应用图标也不会凭空变成好用的菜单栏剪影。

WEB / PWA

浏览器版面

Favicon SVG 与 ICO、Apple touch icon、192px 和 512px 的 PWA 资产,以及可遮罩图标(maskable icon)与 manifest 代码片段。

--targets web,pwa
TAURI

桌面端资产包

多种尺寸的 PNG、ICO、ICNS,以及适用于 Tauri v2 桌面应用的常规 src-tauri/icons 目录结构。

--targets tauri
ELECTRON

打包工具输入源

适用于 Electron 与 electron-builder 打包工作流的跨平台 PNG、ICO 及 ICNS 资产。

--targets electron
TRAY

菜单栏标识

彩色托盘 PNG、macOS 模板资产及 TypeScript 辅助代码。强烈建议提供专门的纯标识 tray.svg

--targets tray

构建示例

单一源文件。清晰的分支产物。

项目旁可编辑的 master.svg 始终是唯一的事实来源。所有生成的文件均可随时重新构建。

icon-out/
├── favicon.svg
├── favicon.ico
├── icon-192.png
├── icon-512.png
├── icon-512-maskable.png
├── icons/
│   ├── icon.ico
│   └── icon.icns
├── build/
│   ├── icon.png
│   ├── icon.ico
│   └── icon.icns
└── tray/
    ├── tray.png
    ├── trayTemplate.png
    └── trayIcon.ts

已知边界

本地运行并不意味着
拥有魔法。

  • 目前仅支持源码安装。IconFlow 尚未在 PyPI 上发布。在官方版本正式发布之前,请勿使用 pip install ai-iconflow
  • 仅需单次下载。安装配置阶段需要联网下载依赖项和 Playwright Chromium;之后的渲染与构建均完全在本地进行。
  • 桌面端支持范围。Tauri 输出目前仅涵盖桌面端资产,不包含 Android 或 iOS 的启动图与图标集。
  • 绑定工具链的校样。可复现性建立在相同的规范化 SVG、配置,以及相同版本的 IconFlow、Chromium 和 Pillow 基础之上。

就绪接入你的项目

始于实际需求。
终于确凿证据。

运行一次引擎校样。随后打开你的产品代码仓库,向智能体提供一份详实的简报,并将每项设计决策留存在未来维护者随时可查验的地方。