OO

oil-oil/grok-designer

Developer tools
61 stars 品質 40 トレンド 40

委托外部设计顾问评审界面与交互,输出改进建议、视觉方向及 HTML、SVG 草稿。

概要

委托外部设计顾问评审界面与交互,输出改进建议、视觉方向及 HTML、SVG 草稿。 The skill asks Grok 4.5 for design judgment through the bundled grok-designer CLI, then lets the main agent decide how to apply the advice in the current workspace. The easiest way is to give this GitHub repository to an agent such as Codex, Claude Code, or Cursor and ask it to install the skill: You can also install it directly from a terminal: After installation, agents should use the grok-designer skill when a task needs external design judgment. Do not commit API keys or local config files. The repository ignores common local secret files, including .env, config.toml, and api_key. - Grok is stateless. It only sees the current prompt, files passed with -f, and images passed with -i. - For visual/UI review, use grok-designer ui. - For UX, component-choice, task-flow, interaction, friction, or state-feedback review, use grok-designer ux. - For combined UI + UX review, use grok-designer ui,ux or run ui and ux separately.

README

Grok Designer

委托外部设计顾问评审界面与交互,输出改进建议、视觉方向及 HTML、SVG 草稿。

The skill asks Grok 4.5 for design judgment through the bundled grok-designer CLI, then lets the main agent decide how to apply the advice in the current workspace.

Install

The easiest way is to give this GitHub repository to an agent such as Codex, Claude Code, or Cursor and ask it to install the skill:

https://github.com/oil-oil/grok-designer

You can also install it directly from a terminal:

npx skills add oil-oil/grok-designer

After installation, agents should use the grok-designer skill when a task needs external design judgment.

Authorization

The CLI reads local configuration from:

~/.config/grok-designer/config.toml

By default, the API key is read from:

~/.config/grok-designer/api_key

Do not commit API keys or local config files. The repository ignores common local secret files, including .env, config.toml, and api_key.

What Agents Should Know

  • Grok is stateless. It only sees the current prompt, files passed with -f, and images passed with -i.
  • For visual/UI review, use grok-designer ui.
  • For UX, component-choice, task-flow, interaction, friction, or state-feedback review, use grok-designer ux.
  • For combined UI + UX review, use grok-designer ui,ux or run ui and ux separately.
  • For broad art direction or design imagery markdown, use grok-designer direction.
  • For new standalone HTML mockups, use grok-designer html.
  • For SVG icons, simple illustrations, and single handwritten wordmarks, use grok-designer svg.
  • Pass complete relevant files when Grok needs to judge an existing design.
  • Pass screenshots or visual references with -i when the visible result or state sequence matters.
  • Do not ask Grok to patch project files directly. Use its advice, then apply the changes in the workspace.

CLI

可以直接使用 bundled 脚本;只有用户要求全局安装时才安装命令:

grok-designer

Typical examples:

grok-designer ui "给这个页面提视觉/UI设计建议" -f ./design.html -o design-page-ui.md
grok-designer ux "评审这个页面的任务流、交互摩擦和状态反馈" -f ./design.html -o design-page-ux.md
grok-designer ui,ux "同时从 UI 和 UX 角度评审这个标签编辑组件" -f ./TagEditor.tsx -o tag-editor-review.md
grok-designer direction "给这个产品生成设计意象 markdown" -o product-design-imagery.md
grok-designer html "生成一个完整的产品页面设计稿" -f ./brief.md -o ./designs/product-page.html
grok-designer svg "为 Museon 生成一个手写 SVG 字标" -o museon-wordmark.svg

Bare output filenames are saved under .grok-designer/ in the current workspace.

For multi-command markdown review, a single -o value is suffixed per command. For example, -o tag-editor-review.md writes tag-editor-review-ui.md and tag-editor-review-ux.md.

Repository Layout

SKILL.md
scripts/grok-designer
scripts/install_cli

SKILL.md tells agents when and how to use Grok. scripts/install_cli installs the CLI into the user’s local bin directory. scripts/grok-designer is the command agents call.

配置、依赖与使用边界

Python 3.11+;可直接运行 scripts/grok-designer,不必全局安装。优先读取可信运行环境中的 ZENMUX_API_KEY,兼容读取已有私有凭据文件;本 CLI 不创建密钥文件,缺失时由用户的可信凭据环境配置。

选定文件和图片会发给配置的模型供应商,可能计费。结构校验不代表视觉正确;用户已有实施授权时不重复要求同一授权。

使用示例:

用 Grok Designer 给这个界面提供 UI 建议,保留现有品牌。

API Key 配置页面

首次使用外部服务时,可以在本机配置页亲自填写 Key;已有配置会复用,密钥存入系统凭据库。只为实际使用的外部服务配置;纯本地处理不需要 Key。页面需要 Node.js 22.18+ 与可用的系统凭据服务,业务运行仍使用原依赖。

安装、状态检查、打开页面和带凭据运行的完整入口见配置说明。页面保存与业务读取已经接通;不把 Key 发进聊天,也不自动迁移旧文件。

View this README on GitHub

推奨ツール

別のキーワードを試すか、フィルタを外してください。

インストール

npx skillfish add oil-oil/grok-designer