Brand Logo Generator

SurgePix Brand Logo Generator

Generate a brand logo image from a text description plus optional reference images via the platform API, and return a download link.

What the Skill Does

Workflow

1. Step 0: Check environment (required)

   Before running, verify config:

   node "<skills-dir>/surgepix-setup/scripts/check_env.mjs"

   • Exit 0 → proceed to Step 1
   • Exit 1 → configure .env following the surgepix-setup skill, then retry

2. Step 1: Gather inputs

   --brand-name and --prompt are required; the rest are optional.

   • Brand name (required): the brand name text, which must appear in the logo.
   • Prompt (required): describe the industry, core meaning, style direction, and color preferences. The more detailed the description, the closer the generated logo matches the need.
   • Reference image (optional): local file path or image URL; the script uploads automatically. Repeatable for multiple images. Supported formats: JPEG / JPG / PNG / WEBP — max 20MB each.
   • Format (optional, default png): output format. png = transparent background PNG (ideal for overlaying); jpg = colored JPG (e.g. white / brand-color background, ideal for direct display).
   • Size (optional, default 1024x1024): output image size in WxH format. e.g. 1024x1024,1080x1080,1920x1080.
   • Session ID (optional): when iterating on a previous result, ask for the sessionId (number type) printed by the previous run; omit for a fresh request — the platform auto-creates a new session.
   • Local reference image → script uploads automatically, then calls API
   • Reference image URL → script uses it directly

3. Step 2: Run generate-logo

   node "<skills-dir>/surgepix-generate-logo/scripts/generate_logo.mjs" \
     --brand-name "<brand-name>" --prompt "<description>" \
     [--reference "<path-or-url>" ...] [--format <png|jpg>] [--size <WxH>] \
     [--session-id <id>] [--nowait <true|false>]

   Flag	Description
   --brand-name <text>	Brand name text, which will appear in the logo (required)
   --prompt <text>	Text description for the logo design (required)
   --reference <path-or-url>	Reference image (local path auto-uploaded; repeatable for multiple files)
   --format <png|jpg>	Output format: png (transparent background) / jpg (colored background), default png
   --size <WxH>	Output size in WxH format, default 1024x1024
   --session-id <id>	Session ID; pass the sessionId (number type) from a previous run to iterate
   --nowait <true|false>	Wait mode, default false (see below)

   The request is always submitted asynchronously. --nowait false (default) makes the script poll internally until the task completes and returns the final download--nowait true makes the script return the taskId immediately, to be resolved later via the surgepix-query-task skill.

4. Step 3: Parse output

   Sync success (--nowait false, stdout):

   {"ok":true,"taskId":"task_xxx","sessionId":123,"progress":"succeeded","download":"https://...images.zip","imageCount":4,"resultType":"zip","note":"API 仅返回 ZIP 下载地址，不含单张图片 URL；禁止编造单张链接"}

   Async submitted (--nowait true, stdout) — resolve later with the surgepix-query-task skill:

   {"ok":true,"async":true,"taskId":"task_xxx","sessionId":123,"progress":"processing","download":null,"hint":"..."}

   Failure (stderr):

   {"ok":false,"error":"..."}

5. Step 4: Present result

   • On success: Show only the download URL from script output. Always show sessionId (note: it is a number type, e.g. 123 ) so the user can pass it in a retry if needed.
   • On failure: Report the error field. Common causes:
     • missing_required_param — --brand-name or --prompt not provided
     • unsupported_image_format — reference image format not supported
     • image_too_large — reference image exceeds 20MB
     • invalid_param_value — invalid --size format or value
     • generation_failed — internal error; retry or simplify the description