@miketromba/ploof 0.1.3 → 0.1.5

package/README.md

@@ -9,7 +9,7 @@
   <img src="https://img.shields.io/badge/node-%3E%3D18-brightgreen" alt="node version" />
 </p>
 
-Ploof is a CLI for generating and editing creative assets with AI providers. It supports OpenAI image generation and editing today, with a provider registry designed for audio, video, and broader model marketplaces over time.
+Ploof is a CLI for generating and editing creative assets with AI providers. It supports OpenAI image generation and editing today, plus the legacy OpenAI image variations endpoint when the authenticated project has access. The provider registry is designed for audio, video, and broader model marketplaces over time.
 
 It is built for both developers and AI agents: predictable commands, parseable output, local auth profiles, YAML manifests, parallel execution, and a companion skill.
 
@@ -20,6 +20,7 @@ It is built for both developers and AI agents: predictable commands, parseable o
 | OpenAI auth profiles | Supported |
 | OpenAI image generation | Supported |
 | OpenAI image editing | Supported |
+| OpenAI image variations | Legacy endpoint; supported when available to the authenticated project |
 | Context images and masks | Supported |
 | YAML/JSON batch manifests | Supported |
 | Dependency-aware parallel runs | Supported |
@@ -58,7 +59,6 @@ ploof login openai --api-key <your-api-key>
 ploof image generate \
   --prompt "Studio product photo of a matte black water bottle" \
   --out assets/hero.png \
-  --model gpt-image-2 \
   --size 1024x1024
 
 # Edit an image with context
@@ -108,6 +108,8 @@ ploof login openai \
 
 ## Image Generation
 
+OpenAI image generation and editing default to `gpt-image-2` when `--model` is omitted.
+
 ```bash
 ploof image generate \
   --provider openai \
@@ -150,6 +152,24 @@ ploof image edit \
 
 Use repeated `--image` flags for context/reference images. Use `--mask` when the selected provider/model supports masked edits.
 
+## Image Variations
+
+OpenAI image variations use the legacy variations endpoint and default to `dall-e-2`, which is currently the only supported model for that endpoint. If OpenAI returns a 404 for this command, use `ploof image edit` for image-to-image workflows or try a profile/project with DALL-E 2 variation access.
+
+```bash
+ploof image variation \
+  --provider openai \
+  --image input.png \
+  --out variation.png \
+  --size 1024x1024
+```
+
+The plural alias also works:
+
+```bash
+ploof image variations --image input.png --out variation.png
+```
+
 ## Batch Manifests
 
 ```yaml
@@ -176,6 +196,15 @@ tasks:
       mask: ./mask.png
     prompt: "Add a premium background"
     output: assets/final.png
+
+  - id: variation
+    kind: image.variation
+    provider: openai
+    needs: [base]
+    inputs:
+      images:
+        - task: base
+    output: assets/variation.png
 ```
 
 Run it:

package/SPEC.md

@@ -86,6 +86,7 @@ Initial capabilities:
 
 - `image.generate`
 - `image.edit`
+- `image.variation`
 
 Future providers should be added through the provider registry without changing the manifest model.
 
@@ -176,6 +177,8 @@ ploof config reset
 
 ### Image Generation
 
+OpenAI image generation and editing default to `gpt-image-2` when no model is specified.
+
 ```bash
 ploof image generate \
   --provider openai \
@@ -209,6 +212,23 @@ ploof image edit \
 
 The CLI must support multiple context images where the provider supports them.
 
+### Image Variations
+
+```bash
+ploof image variation \
+  --provider openai \
+  --image input.png \
+  --out assets/variation.png \
+  --model dall-e-2 \
+  --size 1024x1024
+```
+
+OpenAI variations default to `dall-e-2`, because the legacy OpenAI variations
+endpoint only supports that model. This endpoint is supported when the
+authenticated project has DALL-E 2 variation access; if OpenAI returns a 404,
+use `ploof image edit` for image-to-image workflows. `ploof image variations`
+is an alias.
+
 ### Batch Run
 
 ```bash
@@ -241,6 +261,15 @@ tasks:
       mask: ./mask.png
     prompt: "Add a premium background"
     output: assets/final.png
+
+  - id: variation
+    kind: image.variation
+    provider: openai
+    needs: [base]
+    inputs:
+      images:
+        - task: base
+    output: assets/variation.png
 ```
 
 ## Asset Input Model
@@ -280,6 +309,7 @@ type Provider = {
   capabilities: ProviderCapability[]
   runImageGenerate(job, context): Promise<ProviderResult>
   runImageEdit(job, context): Promise<ProviderResult>
+  runImageVariation(job, context): Promise<ProviderResult>
 }
 ```
 
@@ -429,7 +459,7 @@ The initial complete implementation should include:
 - npm package scaffolding for `@miketromba/ploof`.
 - Build, test, typecheck, lint setup.
 - OpenAI auth profiles.
-- OpenAI image generate/edit.
+- OpenAI image generate/edit/variation.
 - Asset input normalization.
 - Manifest run with dependency-aware parallelism.
 - Output formats and sidecar metadata.