跳到正文

flatkey-ai

awesome-images

Try flatkey.ai for 40% saving! Generate practical images ready for all your work needs!!!

README 已保存到本站,可直接阅读

Documentation snapshot

README 快照

这篇是英文原文

下面正文是项目自己的英文 README。想读全文就用浏览器自带的整页翻译: Chrome / Edge 点地址栏右侧的翻译图标,或用右键菜单里的「翻译成中文」; 手机浏览器一般在菜单里。

本页保存的是公开项目资料快照,阅读过程不需要连接 GitHub。

Flatkey Image Prompt Library

English | 中文 | 日本語 | Español | Português | Tiếng Việt

Image Buddy is a commercial prompt library and CLI for generating useful marketing images with Flatkey.ai). Flatkey can be about 40% cheaper than common direct image API routes, and this repo makes it easier to turn that lower cost into usable product images, ads, avatars, app visuals, and ecommerce creatives.

Get API key: <https://flatkey.ai>

What You Get

  • Lower generation cost: use Flatkey.ai for image generation, often around 40% cheaper than common direct API routes.
  • Commercial prompts that work: templates are written for product, ecommerce, social ads, UI screenshots, avatars, posters, game assets, and edits.
  • Fast generation demo: use image-buddy web to open a local demo gallery and generate images with a Flatkey key.
  • CLI-first workflow: onboard once, then generate from a short sentence or a template hint.

Includes

Skill: a copy-paste prompt for your AI agent. The agent installs and uses Image Buddy for you, backed by the CLI.

Paste this into your AI assistant:

Install and use the Flatkey Image Buddy skill from https://github.com/flatkey-ai/awesome-images.
When I ask for an image, use image-buddy CLI with Flatkey. First run image-buddy onboard if needed, then generate the image from my short prompt or from a template hint. Do not stop at suggesting prompts.

CLI: one command-line tool for onboarding and generation.

  • image-buddy onboard: save your Flatkey API key locally.
  • image-buddy generate --prompt "...": generate from a plain sentence.
  • image-buddy generate avatar-pack "地雷妹": generate from a template plus hint.
  • image-buddy web: open the optional demo gallery.

Quickstart

Generate an image with no local install:

npx @flatkey-ai/image-buddy onboard
npx @flatkey-ai/image-buddy generate --prompt "premium product hero image for an AI image API CLI"

Use a template with a short hint:

npx @flatkey-ai/image-buddy generate avatar-pack "地雷妹"

Open the optional web gallery:

npx @flatkey-ai/image-buddy web

No API key yet? Create one at . The CLI reads the saved key, FLATKEY_IMAGE_API_KEY, or FLATKEY_API_KEY.

Why This Exists

  • Lower activation friction: users start from proven templates instead of a blank prompt box.
  • Increase API conversion: every template card sends users to Flatkey API key registration.
  • Cover common commercial use cases: product marketing, ecommerce images, social ads, infographics, avatars, app screenshots, game assets, and image edits.
  • Support batch workflows: templates use {{variable}} placeholders, so apps can replace values before sending final prompts to an API.
  • Work as marketing content: useful as a prompt gallery, tutorial page, landing page, or onboarding resource.

Included Templates

This library currently includes 12 high-frequency image prompt templates:

  • Premium product hero visual
  • White-background ecommerce main image
  • UGC ad cover frame
  • Liquid glass Bento infographic
  • Founder quote card
  • Consistent avatar pack
  • App Store screenshot poster
  • YouTube thumbnail
  • Event poster key visual
  • Game prop concept sheet
  • Subject-preserving background replacement
  • Fashion lookbook collage

Each template includes:

  • Title and use case
  • Category and recommended model
  • Replaceable variables
  • Full prompt text
  • API use-case note
  • Copy prompt button
  • Flatkey API key registration link

The reusable templates are also exported as a reviewable, machine-readable catalog at catalog/prompts.json. Browse the generated industry index when you want to find a use case before opening the CLI gallery. The catalog is content-only; it is not a prompt-generation API.

The web gallery ships with 20 generated demo images. These are included in the npm package and shown by image-buddy web.

ProductEcommerceSocial AdApp
图片:SaaS Hero PhoneSaaS Hero Phone图片:Skincare ProductSkincare Product图片:UGC Coffee AdUGC Coffee Ad图片:Fitness AppFitness App
PosterInfographicFashionGame Asset
图片:AI Agent PosterAI Agent Poster图片:Liquid BentoLiquid Bento图片:Streetwear LookbookStreetwear Lookbook图片:Crystal Game PropCrystal Game Prop
FoodTravelPortraitReal Estate
图片:Dessert HeroDessert Hero图片:Travel MapTravel Map图片:Cyber PortraitCyber Portrait图片:Interior RenderInterior Render
EntertainmentEducationFinanceBeauty
图片:Music CoverMusic Cover图片:Education CardEducation Card图片:Finance DashboardFinance Dashboard图片:Beauty MakeupBeauty Makeup
ArchitecturePetSportsPublishing
图片:Architecture ModelArchitecture Model图片:Pet BrandPet Brand图片:Sports ShoeSports Shoe图片:Book CoverBook Cover

CLI Usage

Generate from plain English:

npx @flatkey-ai/image-buddy onboard
npx @flatkey-ai/image-buddy generate --prompt "premium product hero image for an AI image API CLI, clean SaaS style, teal accents, sharp commercial lighting"

Generate from a template:

npx @flatkey-ai/image-buddy onboard
npx @flatkey-ai/image-buddy generate avatar-pack "地雷妹"

For precise template control, pass variables explicitly:

npx @flatkey-ai/image-buddy generate premium-product-hero \
  --var "产品名称=Image Buddy" \
  --var "品牌调性=clean SaaS" \
  --var "核心卖点=one-command image generation" \
  --var "主色=teal" \
  --size 1536x1024

Template text after the id is used as a hint. Missing variables are filled from that hint, so users do not need to learn every --var name before generating.

onboard prompts for a Flatkey API key and saves it locally. If you do not have a key, get one at . The CLI also accepts FLATKEY_IMAGE_API_KEY or FLATKEY_API_KEY, calls Flatkey image generation, and saves images locally. No web server required.

generate defaults to Nano Banana through router.flatkey.ai because it works well for direct CLI generation. Use --model gpt when you explicitly want the OpenAI-compatible GPT Image 2 endpoint.

Browse templates from terminal:

npx @flatkey-ai/image-buddy list
npx @flatkey-ai/image-buddy show premium-product-hero
npx @flatkey-ai/image-buddy render premium-product-hero --var "产品名称=Image Buddy"

Optional web gallery:

npx @flatkey-ai/image-buddy web --port 5173

Source install before npm release:

npx github:flatkey-ai/awesome-images

Useful options:

npx @flatkey-ai/image-buddy web --port 5173
npx @flatkey-ai/image-buddy web --no-open
npx @flatkey-ai/image-buddy --help

Developer commands:

npm install
npm test
npm run build:catalog
npm run build

User Flow

  1. Run npx @flatkey-ai/image-buddy generate or npx @flatkey-ai/image-buddy generate --prompt "...".
  2. Find a template by category or keyword.
  3. Expand the template and copy the prompt.
  4. Replace variables such as {{product_name}}, {{core_benefit}}, or {{brand_color}}.
  5. Register a Flatkey API key at <https://flatkey.ai>.
  6. Run image-buddy generate to create and save images locally.

Template Structure

All templates live in src/prompts.js.

Add a new template by appending an object:

{
  id: "unique-template-id",
  title: "Template title",
  industry: "ecommerce-retail",
  category: "product",
  badge: "Hero",
  aspectRatio: "16:9",
  model: "gpt-image-2",
  apiUseCase: "Best-fit API use case.",
  description: "Template description.",
  variables: ["product_name", "core_benefit"],
  prompt: "Create a commercial hero image for {{product_name}}..."
}

Use industry for the business context and category for the visual production pattern. Keep the human-facing description separate from the model-facing prompt; details are documented in docs/prompt-format.md.

After adding templates, run:

npm test

The validator checks template count, categories, variables, prompt length, and Flatkey registration links.

Release Publishing

Publishing runs from GitHub Releases.

  1. Add an npm automation token to GitHub repository secrets as NPM_PUBLISH_TOKEN.
  2. Create a GitHub Release with tag v1.2.3 or 1.2.3.
  3. The workflow sets package.json and package-lock.json to that release version.
  4. The workflow runs validation, build, and npm publish --access public.

Star History

图片:Star History Chart

Official distribution

获取与安装

暂未发现可确认的官方软件包地址

当前 README 快照没有出现 npm、PyPI、Crates.io、pub.dev 等官方包页链接。本站不会根据仓库名称猜测下载地址。

本站不托管项目文件;需要安装时,请以项目维护者发布的官方文档为准。

使用前核验

本站保存公开资料用于阅读,不代表安全审计或功能背书。安装前请核对许可证、依赖来源和发布签名,不要直接运行来源不明的二进制文件或高权限脚本。