imgx-cli 0.5.1 → 0.6.0

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.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # Changelog
2
2
 
3
+ ## 0.5.2 (2026-02-26)
4
+
5
+ ### Fixed
6
+
7
+ - `imgx-mcp` bin: added missing shebang (`#!/usr/bin/env node`) — fixes `npx imgx-mcp` and Claude Desktop MCP integration on all platforms
8
+
9
+ ### Changed
10
+
11
+ - README: add Claude Desktop MCP configuration (Windows `cmd /c` + macOS/Linux)
12
+ - README: switch all MCP config examples from local `node` path to `npx`
13
+ - README: replace "Version updates" with full release checklist (version bump → build → publish → verify)
14
+
3
15
  ## 0.5.1 (2026-02-26)
4
16
 
5
17
  ### Added
@@ -10,6 +22,7 @@
10
22
 
11
23
  ### Changed
12
24
 
25
+ - README: added Claude Desktop MCP configuration section with output directory note
13
26
  - README: added Google AI Studio link for API key setup, MCP env section note
14
27
 
15
28
  ## 0.5.0 (2026-02-26)
package/README.md CHANGED
@@ -2,8 +2,6 @@
2
2
 
3
3
  AI image generation and editing from the terminal. Provider-agnostic design with capability-based abstraction.
4
4
 
5
- <!-- TODO: Add demo GIF showing generate → edit → edit --last workflow -->
6
-
7
5
  ## Install
8
6
 
9
7
  ### As a Claude Code plugin
@@ -206,38 +204,76 @@ Add to your tool's MCP config. The `env` section is optional if you have already
206
204
  {
207
205
  "mcpServers": {
208
206
  "imgx": {
209
- "command": "node",
210
- "args": ["/path/to/imgx-cli/dist/mcp.bundle.js"],
207
+ "command": "npx",
208
+ "args": ["--package=imgx-cli", "-y", "imgx-mcp"],
211
209
  "env": { "GEMINI_API_KEY": "your-api-key" }
212
210
  }
213
211
  }
214
212
  }
215
213
  ```
216
214
 
215
+ On Windows, replace `"command": "npx"` with `"command": "cmd"` and prepend `"/c"` to the args array.
216
+
217
+ Or install as a [Claude Code plugin](#install) for automatic MCP registration.
218
+
217
219
  **Gemini CLI** (`~/.gemini/settings.json`):
218
220
 
219
221
  ```json
220
222
  {
221
223
  "mcpServers": {
222
224
  "imgx": {
223
- "command": "node",
224
- "args": ["/path/to/imgx-cli/dist/mcp.bundle.js"],
225
+ "command": "npx",
226
+ "args": ["--package=imgx-cli", "-y", "imgx-mcp"],
227
+ "env": { "GEMINI_API_KEY": "your-api-key" }
228
+ }
229
+ }
230
+ }
231
+ ```
232
+
233
+ **Claude Desktop** (`claude_desktop_config.json`):
234
+
235
+ macOS / Linux:
236
+
237
+ ```json
238
+ {
239
+ "mcpServers": {
240
+ "imgx": {
241
+ "command": "npx",
242
+ "args": ["--package=imgx-cli", "-y", "imgx-mcp"],
243
+ "env": { "GEMINI_API_KEY": "your-api-key" }
244
+ }
245
+ }
246
+ }
247
+ ```
248
+
249
+ Windows:
250
+
251
+ ```json
252
+ {
253
+ "mcpServers": {
254
+ "imgx": {
255
+ "command": "cmd",
256
+ "args": ["/c", "npx", "--package=imgx-cli", "-y", "imgx-mcp"],
225
257
  "env": { "GEMINI_API_KEY": "your-api-key" }
226
258
  }
227
259
  }
228
260
  }
229
261
  ```
230
262
 
263
+ Config file location: `%APPDATA%\Claude\claude_desktop_config.json` (Windows) or `~/Library/Application Support/Claude/claude_desktop_config.json` (macOS). After editing, restart Claude Desktop.
264
+
265
+ > **Note:** Claude Desktop runs the MCP server from its own app directory. Images will be saved there by default. To control the output location, add `"IMGX_OUTPUT_DIR": "C:\\Users\\you\\Pictures"` to the `env` section, or run `imgx config set output-dir <path>` beforehand.
266
+
231
267
  **Codex CLI** (`.codex/config.toml`):
232
268
 
233
269
  ```toml
234
270
  [mcp_servers.imgx]
235
- command = "node"
236
- args = ["/path/to/imgx-cli/dist/mcp.bundle.js"]
271
+ command = "npx"
272
+ args = ["--package=imgx-cli", "-y", "imgx-mcp"]
237
273
  env = { GEMINI_API_KEY = "your-api-key" }
238
274
  ```
239
275
 
240
- The same configuration pattern works with Cursor, Windsurf, Continue.dev, Cline, Zed, and other MCP-compatible tools.
276
+ The same `npx` pattern works with Cursor, Windsurf, Continue.dev, Cline, Zed, and other MCP-compatible tools. On Windows, use `cmd /c npx` instead of `npx` directly.
241
277
 
242
278
  ## Architecture
243
279
 
@@ -273,56 +309,6 @@ Each provider declares its supported capabilities. The CLI dynamically enables o
273
309
  |----------|--------|-------------|
274
310
  | Gemini | `gemini-3-pro-image-preview`, `gemini-2.5-flash-image` | All 7 capabilities |
275
311
 
276
- ## Plugin structure
277
-
278
- imgx-cli doubles as an AI coding tool plugin. The repository contains:
279
-
280
- ```
281
- .claude-plugin/
282
- ├── plugin.json # Claude Code plugin manifest
283
- └── marketplace.json # Marketplace definition for plugin discovery
284
- .cursor-plugin/
285
- └── plugin.json # Cursor plugin manifest
286
- .mcp.json # MCP server config (auto-registered on plugin install)
287
- skills/
288
- └── image-generation/
289
- ├── SKILL.md # Skill instructions
290
- └── references/
291
- └── providers.md # Provider and model reference
292
- dist/
293
- ├── cli.bundle.js # Bundled CLI (tracked in git for plugin distribution)
294
- └── mcp.bundle.js # Bundled MCP server
295
- ```
296
-
297
- When installed as a plugin, the tool clones this repository and registers the skill. The skill instructs the AI to execute `dist/cli.bundle.js` via bash when image generation or editing is requested.
298
-
299
- ### Plugin configuration files
300
-
301
- **`.claude-plugin/plugin.json`** — Plugin identity. Fields: `name`, `description`, `version`, `author`. No `category` field (that belongs in `marketplace.json` only).
302
-
303
- **`.claude-plugin/marketplace.json`** — Marketplace wrapper. The `source` field must use URL format for self-referencing repositories:
304
-
305
- ```json
306
- "source": {
307
- "source": "url",
308
- "url": "https://github.com/somacoffeekyoto/imgx-cli.git"
309
- }
310
- ```
311
-
312
- **`skills/image-generation/SKILL.md`** — Uses `${CLAUDE_PLUGIN_ROOT}` variable for portable CLI paths. Frontmatter (`name`, `description`) is required for skill registration.
313
-
314
- ### Version updates
315
-
316
- When releasing a new version, update the version string in all locations:
317
-
318
- 1. `package.json` — npm package version
319
- 2. `src/cli/index.ts` — CLI `--version` output
320
- 3. `.claude-plugin/plugin.json` — Claude Code plugin manifest version
321
- 4. `.claude-plugin/marketplace.json` — Marketplace plugin entry version
322
- 5. `.cursor-plugin/plugin.json` — Cursor plugin manifest version
323
-
324
- Then rebuild (`npm run bundle`) and commit `dist/cli.bundle.js` since plugin distribution relies on the git repository.
325
-
326
312
  ## Development
327
313
 
328
314
  ```bash