JAE-IMAGE-SKILL/README.md

82 lines
2.8 KiB
Markdown

# JAE-IMAGE-SKILL — Curated Image Prompt Recommender for AI Agents
JAE-IMAGE-SKILL is an installable AI-agent skill for finding, recommending, and customising proven image-generation prompts. It works with Agent Zero / Agent JAE, Claude-style skill loaders, Cursor, Codex, Gemini CLI, Windsurf, and other agents that can read a `SKILL.md` file and local JSON references.
The skill is model-agnostic. The prompts can be adapted for Midjourney, DALL-E, GPT Image, Flux, Stable Diffusion, Gemini image models, Seedream, and other text-to-image systems.
## Canonical install link
Give this URL to an AI agent and tell it to install the skill:
```text
https://jaeswift.xyz/skills/JAE-image-skill/Jae-Image-Skill.MD
```
The installer markdown explains how to clone or download the skill, where to place it, how to validate it, and how to use it.
## Repository contents
```text
jae-image-skill/
SKILL.md # instructions loaded by the AI agent
package.json # optional Node package metadata + setup scripts
scripts/setup.js # refreshes reference JSON from JaeSwift static hosting
references/manifest.json # dynamic category manifest
references/*.json # prompt reference data
LICENSE # MIT licence retained from upstream
NOTICE # derivative/provenance notice
```
## Quick manual install
```bash
SKILLS_DIR="${SKILLS_DIR:-$HOME/.agent-zero/skills}"
mkdir -p "$SKILLS_DIR"
git clone https://git.jaeswift.xyz/jae/JAE-IMAGE-SKILL.git "$SKILLS_DIR/jae-image-skill"
cd "$SKILLS_DIR/jae-image-skill"
node scripts/setup.js --check || node scripts/setup.js
```
If your agent uses a different skills root, install the folder there instead. The required file is `SKILL.md`; the references are JSON files under `references/`.
## Usage examples
Ask your agent:
```text
Use JAE Image Skill to find a cyberpunk avatar prompt with sample images.
```
```text
Use JAE Image Skill to find three YouTube thumbnail prompt styles for a Solana market update video.
```
```text
Here is my article. Use JAE Image Skill to recommend a matching cover-image prompt, then remix it for my topic.
```
The agent should return up to three prompt recommendations with sample image URLs and a concise reason each one matches.
## Reference refresh
References are hosted under:
```text
https://jaeswift.xyz/skills/JAE-image-skill/references/manifest.json
```
Refresh manually:
```bash
node scripts/setup.js --force
```
Override the source if mirroring elsewhere:
```bash
JAE_IMAGE_SKILL_BASE_URL=https://example.com/references node scripts/setup.js --force
```
## Licence
MIT. This is a JaeSwift-maintained derivative of an MIT-licensed upstream project. The original copyright notice is retained in `LICENSE`; derivative details are in `NOTICE`.