@amaster.ai/pi-image-gen 0.1.2-beta.15

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (52) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +310 -0
  3. package/dist/config.d.ts +24 -0
  4. package/dist/config.d.ts.map +1 -0
  5. package/dist/config.js +183 -0
  6. package/dist/config.js.map +1 -0
  7. package/dist/errors.d.ts +16 -0
  8. package/dist/errors.d.ts.map +1 -0
  9. package/dist/errors.js +70 -0
  10. package/dist/errors.js.map +1 -0
  11. package/dist/generate.d.ts +12 -0
  12. package/dist/generate.d.ts.map +1 -0
  13. package/dist/generate.js +86 -0
  14. package/dist/generate.js.map +1 -0
  15. package/dist/image-input.d.ts +25 -0
  16. package/dist/image-input.d.ts.map +1 -0
  17. package/dist/image-input.js +153 -0
  18. package/dist/image-input.js.map +1 -0
  19. package/dist/index.d.ts +18 -0
  20. package/dist/index.d.ts.map +1 -0
  21. package/dist/index.js +147 -0
  22. package/dist/index.js.map +1 -0
  23. package/dist/models.d.ts +18 -0
  24. package/dist/models.d.ts.map +1 -0
  25. package/dist/models.js +86 -0
  26. package/dist/models.js.map +1 -0
  27. package/dist/providers/dashscope.d.ts +12 -0
  28. package/dist/providers/dashscope.d.ts.map +1 -0
  29. package/dist/providers/dashscope.js +89 -0
  30. package/dist/providers/dashscope.js.map +1 -0
  31. package/dist/providers/gemini.d.ts +10 -0
  32. package/dist/providers/gemini.d.ts.map +1 -0
  33. package/dist/providers/gemini.js +99 -0
  34. package/dist/providers/gemini.js.map +1 -0
  35. package/dist/providers/index.d.ts +3 -0
  36. package/dist/providers/index.d.ts.map +1 -0
  37. package/dist/providers/index.js +19 -0
  38. package/dist/providers/index.js.map +1 -0
  39. package/dist/providers/openai.d.ts +14 -0
  40. package/dist/providers/openai.d.ts.map +1 -0
  41. package/dist/providers/openai.js +145 -0
  42. package/dist/providers/openai.js.map +1 -0
  43. package/dist/types.d.ts +133 -0
  44. package/dist/types.d.ts.map +1 -0
  45. package/dist/types.js +2 -0
  46. package/dist/types.js.map +1 -0
  47. package/dist/url.d.ts +11 -0
  48. package/dist/url.d.ts.map +1 -0
  49. package/dist/url.js +25 -0
  50. package/dist/url.js.map +1 -0
  51. package/package.json +73 -0
  52. package/preview.png +0 -0
package/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
package/README.md ADDED
@@ -0,0 +1,310 @@
1
+ # @amaster.ai/pi-image-gen
2
+
3
+ ![pi-image-gen preview](https://raw.githubusercontent.com/TGYD-helige/pi/master/packages/pi-image-gen/preview.png)
4
+
5
+ Pi extension that adds an `image_generate` tool. Supported providers:
6
+
7
+ | Provider | Model id (alias) | Env var |
8
+ | ------------------------------ | --------------------------------------------- | --------------------- |
9
+ | OpenAI | `gpt-image-1` (alias `gpt-image-2`) | `OPENAI_API_KEY` |
10
+ | Google Gemini ("Nano Banana") | `gemini-3-pro-image` (alias `nano-banana-pro`), `gemini-3-pro-image-preview`, `gemini-3.1-flash-image` (alias `nano-banana`), `gemini-3.1-flash-image-preview`, `gemini-2.5-flash-image` (alias `nano-banana-2`), `gemini-2.0-flash-image` | `GEMINI_API_KEY` |
11
+ | Alibaba DashScope (Qwen-Image) | `qwen-image-2.0-pro` (alias `qwen-image-pro`), `qwen-image-2.0` (alias `qwen-image-2`, `qwen-image`) | `DASHSCOPE_API_KEY` |
12
+ | OpenRouter | any (use `openrouter/<vendor>/<id>`) | `OPENROUTER_API_KEY` |
13
+ | Custom providers | whatever you declare in settings | (your choice, via `$VAR`) |
14
+
15
+ The env-var names match [pi.dev's provider table](https://pi.dev/docs/latest/providers) — if the agent already has a key set for a provider, this extension will reuse it. You don't need to introduce a new variable.
16
+
17
+ The active model is **fixed in settings.json**. The `image_generate` tool intentionally does **not** take a `model` parameter — point your project at one model, get consistent output. To switch models, edit settings and run `/image-gen reload`.
18
+
19
+ ## Install
20
+
21
+ ```sh
22
+ pnpm add @amaster.ai/pi-image-gen
23
+ ```
24
+
25
+ The package's `pi.extensions` field auto-registers it with the host pi-coding-agent runtime; no extra wiring needed.
26
+
27
+ ## Configure
28
+
29
+ Settings are read by `pi-shared`'s `loadPiSettings`, which merges three files (low-to-high priority):
30
+
31
+ 1. `~/.pi/agent/settings.json` (global)
32
+ 2. `$PI_AGENT_HOME/settings.json` (agent dir, if `PI_AGENT_HOME` is set)
33
+ 3. `<cwd>/.pi/settings.json` (project)
34
+
35
+ All settings live under the `pi-image-gen` key. The minimum viable config sets `defaultModel`:
36
+
37
+ ```json
38
+ {
39
+ "pi-image-gen": {
40
+ "defaultModel": "nano-banana"
41
+ }
42
+ }
43
+ ```
44
+
45
+ …and exports the matching env var:
46
+
47
+ ```sh
48
+ export GEMINI_API_KEY=sk-...
49
+ ```
50
+
51
+ That's it. From the agent: `image_generate({ prompt: "a cyberpunk cat" })`.
52
+
53
+ ### All settings fields
54
+
55
+ ```json
56
+ {
57
+ "pi-image-gen": {
58
+ "defaultModel": "nano-banana",
59
+ "outputDir": ".pi/images",
60
+
61
+ "providers": {
62
+ "openai": { "baseUrl": "https://my-proxy.example.com/v1", "apiKey": "${MY_OPENAI_KEY}" },
63
+ "gemini": { "headers": { "x-goog-trace": "pi-prod" } },
64
+ "dashscope": { "baseUrl": "https://dashscope-intl.aliyuncs.com/api/v1" },
65
+ "openrouter": { "apiKey": "$OPENROUTER_API_KEY" }
66
+ },
67
+
68
+ "customProviders": {
69
+ "my-stable-diffusion": {
70
+ "api": "openai",
71
+ "baseUrl": "https://api.my-sd.example.com/v1",
72
+ "apiKey": "${MY_SD_KEY}",
73
+ "headers": { "x-tenant": "team-a" },
74
+ "models": [
75
+ { "id": "sd-3-large", "alias": "sd3" },
76
+ "sd-3-medium"
77
+ ]
78
+ }
79
+ }
80
+ }
81
+ }
82
+ ```
83
+
84
+ | Field | Purpose |
85
+ | ----------------- | ---------------------------------------------------------------------------------------- |
86
+ | `defaultModel` | Model id or alias the tool will use. **Required.** |
87
+ | `outputDir` | Where to write generated images. Relative paths resolve against the session cwd. Default `.pi/images`. |
88
+ | `providers` | Per-built-in-provider override. Set `apiKey`, `baseUrl`, or `headers` to point at a proxy or non-standard env var. |
89
+ | `customProviders` | User-defined providers — see below. |
90
+
91
+ `apiKey`, `baseUrl`, and `headers` values support `$VAR` and `${VAR}` env interpolation, with `:-` fallback (e.g. `${FOO:-default}`).
92
+
93
+ ## Built-in setup walkthrough
94
+
95
+ ### 1. OpenAI (`gpt-image-1` / `gpt-image-2`)
96
+
97
+ ```sh
98
+ export OPENAI_API_KEY=sk-...
99
+ ```
100
+
101
+ ```json
102
+ { "pi-image-gen": { "defaultModel": "gpt-image-2" } }
103
+ ```
104
+
105
+ ### 2. Google Gemini "Nano Banana"
106
+
107
+ ```sh
108
+ export GEMINI_API_KEY=...
109
+ ```
110
+
111
+ ```json
112
+ { "pi-image-gen": { "defaultModel": "nano-banana" } }
113
+ ```
114
+
115
+ ### 3. Alibaba DashScope (Qwen-Image)
116
+
117
+ ```sh
118
+ export DASHSCOPE_API_KEY=...
119
+ ```
120
+
121
+ ```json
122
+ { "pi-image-gen": { "defaultModel": "qwen-image-2" } }
123
+ ```
124
+
125
+ For the international DashScope endpoint, override the base URL:
126
+
127
+ ```json
128
+ {
129
+ "pi-image-gen": {
130
+ "defaultModel": "qwen-image-2",
131
+ "providers": {
132
+ "dashscope": { "baseUrl": "https://dashscope-intl.aliyuncs.com/api/v1" }
133
+ }
134
+ }
135
+ }
136
+ ```
137
+
138
+ ### 4. OpenRouter (one key, many models)
139
+
140
+ ```sh
141
+ export OPENROUTER_API_KEY=...
142
+ ```
143
+
144
+ ```json
145
+ { "pi-image-gen": { "defaultModel": "openrouter/google/gemini-2.5-flash-image" } }
146
+ ```
147
+
148
+ The string after `openrouter/` is the OpenRouter model slug; pass any image model OpenRouter supports.
149
+
150
+ ## Custom providers
151
+
152
+ Use `customProviders` for anything not built in: a self-hosted Stable Diffusion, an internal corp gateway, a third-party image API. The shape mirrors [pi.dev's custom-provider docs](https://pi.dev/docs/latest/custom-provider).
153
+
154
+ Each custom provider declares:
155
+
156
+ | Field | Required | Notes |
157
+ | ---------- | -------- | ------------------------------------------------------------------------------------ |
158
+ | `api` | yes | One of `openai`, `gemini`, `dashscope`, `openrouter`. Picks the image-API wire shape. |
159
+ | `baseUrl` | yes | API endpoint URL. `$VAR` syntax supported. |
160
+ | `apiKey` | usually | API key string. `$VAR` syntax supported. |
161
+ | `name` | no | Display name shown in `/image-gen list`. |
162
+ | `headers` | no | Extra headers merged into every request. |
163
+ | `models` | no | Optional model id/alias list. Omit to make this a **catch-all** — the provider will accept any unknown model id (passed through as the remote id). Provide a list only when you want aliases or want to route specific ids elsewhere. Each entry is a string or `{ id, alias?, name? }`. |
164
+
165
+ > Note: pi.dev custom providers also have an `api` field, but its values (`openai-completions`, `anthropic-messages`, …) are LLM streaming formats that don't apply to image generation. The values here (`openai`, `gemini`, `dashscope`, `openrouter`) are image-API wire shapes — same field name, different namespace.
166
+
167
+ ### Example: self-hosted Stable Diffusion (OpenAI-compatible)
168
+
169
+ ```sh
170
+ export SD_KEY=local-secret
171
+ ```
172
+
173
+ ```json
174
+ {
175
+ "pi-image-gen": {
176
+ "defaultModel": "sd3",
177
+ "customProviders": {
178
+ "my-sd": {
179
+ "api": "openai",
180
+ "baseUrl": "http://localhost:8000/v1",
181
+ "apiKey": "$SD_KEY",
182
+ "models": [{ "id": "sd-3-large", "alias": "sd3" }]
183
+ }
184
+ }
185
+ }
186
+ }
187
+ ```
188
+
189
+ The agent calls `image_generate({prompt: ...})`; the extension sees `defaultModel: "sd3"`, finds it under `my-sd`, and POSTs to `http://localhost:8000/v1/images/generations` with `Bearer $SD_KEY`.
190
+
191
+ ### Example: Volcengine Doubao image API (OpenAI-compatible)
192
+
193
+ ```json
194
+ {
195
+ "pi-image-gen": {
196
+ "defaultModel": "doubao-seed-image",
197
+ "customProviders": {
198
+ "doubao": {
199
+ "api": "openai",
200
+ "baseUrl": "https://ark.cn-beijing.volces.com/api/v3",
201
+ "apiKey": "${ARK_API_KEY}",
202
+ "models": [{ "id": "doubao-seedream-4-0-250828", "alias": "doubao-seed-image" }]
203
+ }
204
+ }
205
+ }
206
+ }
207
+ ```
208
+
209
+ ### Example: a Gemini-shape proxy
210
+
211
+ If your provider speaks the Google Generative Language wire format:
212
+
213
+ ```json
214
+ {
215
+ "pi-image-gen": {
216
+ "defaultModel": "internal-banana",
217
+ "customProviders": {
218
+ "internal": {
219
+ "api": "gemini",
220
+ "baseUrl": "https://gemini-proxy.corp.example/v1beta",
221
+ "apiKey": "$INTERNAL_GEMINI_KEY",
222
+ "models": [{ "id": "gemini-2.5-flash-image", "alias": "internal-banana" }]
223
+ }
224
+ }
225
+ }
226
+ }
227
+ ```
228
+
229
+ ### Direct addressing without an alias
230
+
231
+ If a custom provider has no `models` list, you can still address it with `<providerName>/<remoteId>`:
232
+
233
+ ```json
234
+ {
235
+ "pi-image-gen": {
236
+ "defaultModel": "my-sd/sd-3-large",
237
+ "customProviders": {
238
+ "my-sd": { "api": "openai", "baseUrl": "http://localhost:8000/v1", "apiKey": "$SD_KEY" }
239
+ }
240
+ }
241
+ }
242
+ ```
243
+
244
+ ## Tool: `image_generate`
245
+
246
+ ```ts
247
+ image_generate({
248
+ prompt: string, // required — what to draw or how to edit
249
+ image?: string[], // optional — array of file paths or http(s) URLs
250
+ n?: number, // 1–8, default 1
251
+ size?: string, // e.g. "1024x1024" — provider-specific
252
+ filename?: string, // filename prefix (no extension)
253
+ outputDir?: string, // override settings.outputDir for this call
254
+ })
255
+ ```
256
+
257
+ Returns the absolute file path(s) of saved images. Files land in `outputDir` (default `<cwd>/.pi/images`), filename pattern `<filename or model-UTC-stamp>.<ext>`.
258
+
259
+ ### Tool result format
260
+
261
+ The tool's text result is shaped as ready-to-paste markdown the model can copy verbatim into its reply, so the UI renders the image inline:
262
+
263
+ ```
264
+ Generated 1 image(s) via amaster (custom) (qwen-image-2.0). Show each one to the user as inline markdown — copy the lines below verbatim into your reply:
265
+
266
+ ![white](/Users/.../white.png)
267
+ ```
268
+
269
+ The `alt` text is the filename without its extension — i.e. whatever you passed as `filename`, or `<model>-<UTC-stamp>` if you didn't. When OpenAI returns a `revised_prompt`, it appears as a quote line under the image:
270
+
271
+ ```
272
+ ![beaver](/Users/.../beaver.png)
273
+ > revised prompt: a cute beaver, photorealistic, water droplets
274
+ ```
275
+
276
+ ### Image-to-image / edit
277
+
278
+ `image` is always an array — pass `["path"]` for a single image, `["a", "b"]` for multi-image conditioning. Each entry must be:
279
+
280
+ - **Local file path** — absolute or relative (resolved against the session cwd).
281
+ - **http(s) URL** — downloaded with the same fetch (and abort signal) used for the API call.
282
+
283
+ Base64 strings and `data:` URIs are intentionally rejected — tool arguments don't survive megabyte-sized strings cleanly. If you have raw image bytes, write them to a file first and pass the path.
284
+
285
+ **Iterating on a previous result:** pass the previous output path back. The next image is conditioned on the last one:
286
+
287
+ ```
288
+ image_generate({ prompt: "a beaver chewing wood", filename: "beaver" })
289
+ → /Users/.../.pi/images/beaver.png
290
+
291
+ image_generate({ prompt: "now in watercolor style", image: ["/Users/.../.pi/images/beaver.png"] })
292
+ → /Users/.../.pi/images/gpt-image-1-20260605-...png (edited)
293
+ ```
294
+
295
+ Provider behavior:
296
+
297
+ | Provider | Image input route |
298
+ |---|---|
299
+ | OpenAI (`gpt-image-1`) | `POST /v1/images/edits` (multipart). Supports multi-image. |
300
+ | Gemini (`gemini-3.x-flash-image`, `nano-banana`) | `inline_data` parts prepended to the user message. Supports multi-image. |
301
+ | DashScope (`qwen-image-2.0`, `qwen-image-2.0-pro`) | `image` parts in `messages[].content`. |
302
+
303
+ There is intentionally no `model` parameter on the tool — the active model is fixed by `pi-image-gen.defaultModel` in settings.
304
+
305
+ ## Slash commands
306
+
307
+ - `/image-gen list` — show the active model, which provider it routes to, whether the key is set, configured providers, and the catalog of built-in model ids.
308
+ - `/image-gen reload` — re-read settings from disk.
309
+
310
+ Use `/image-gen list` to verify your config — it will tell you when `defaultModel` is unset, points at a provider with no API key, or names an unknown id.
@@ -0,0 +1,24 @@
1
+ import type { ImageGenSettings, ResolvedModel, ResolvedProvider } from './types.js';
2
+ export declare function loadImageGenSettings(cwd: string): ImageGenSettings;
3
+ /**
4
+ * Resolve a model id (or alias) to a (provider, remoteModelId) pair using:
5
+ * 1. Custom providers' explicit model lists (alias or id match).
6
+ * 2. Built-in known models (alias or id match).
7
+ * 3. `<provider>/<remote-id>` fallback for explicit routing.
8
+ * 4. Catch-all: any custom provider that didn't declare a `models` list
9
+ * will accept any unknown model id, passing it through as the remote id.
10
+ * This lets users configure a single OpenAI-compatible gateway and use
11
+ * any model name without restating it in `models`.
12
+ */
13
+ export declare function resolveModel(modelOrAlias: string, settings: ImageGenSettings): ResolvedModel | {
14
+ error: string;
15
+ };
16
+ export declare function listKnownModelIds(): string[];
17
+ export type ConfiguredProvider = ResolvedProvider & {
18
+ /** True for customProviders without an explicit `models` list — accepts any unknown id. */
19
+ catchAll: boolean;
20
+ /** Number of model entries explicitly declared. */
21
+ modelCount: number;
22
+ };
23
+ export declare function listConfiguredProviders(settings: ImageGenSettings): ConfiguredProvider[];
24
+ //# sourceMappingURL=config.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAIV,gBAAgB,EAChB,aAAa,EACb,gBAAgB,EACjB,MAAM,YAAY,CAAC;AAIpB,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,MAAM,GAAG,gBAAgB,CASlE;AAsED;;;;;;;;;GASG;AACH,wBAAgB,YAAY,CAC1B,YAAY,EAAE,MAAM,EACpB,QAAQ,EAAE,gBAAgB,GACzB,aAAa,GAAG;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,CAgDnC;AA4BD,wBAAgB,iBAAiB,IAAI,MAAM,EAAE,CAE5C;AAED,MAAM,MAAM,kBAAkB,GAAG,gBAAgB,GAAG;IAClD,2FAA2F;IAC3F,QAAQ,EAAE,OAAO,CAAC;IAClB,mDAAmD;IACnD,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,wBAAgB,uBAAuB,CAAC,QAAQ,EAAE,gBAAgB,GAAG,kBAAkB,EAAE,CAcxF"}