imgx-cli 0.5.2 → 0.6.1

package/CHANGELOG.md

@@ -1,5 +1,30 @@
 # Changelog
 
+## 0.6.1 (2026-02-27)
+
+### Fixed
+
+- Default output directory changed from process cwd to `~/Pictures/imgx` — fixes images being saved to AppData when used via MCP (Claude Desktop, etc.)
+
+## 0.6.0 (2026-02-27)
+
+### Added
+
+- **OpenAI provider** — `gpt-image-1` model with generate and edit support
+  - Native `fetch` implementation (no `openai` npm dependency)
+  - Aspect ratio mapping to OpenAI size strings, resolution mapping to quality parameter
+  - Manual multipart/form-data construction for Node 18 compatibility
+- `OPENAI_API_KEY` environment variable support
+- `--provider` flag for `imgx config set api-key` — manage API keys per provider
+  - `imgx config set api-key <key> --provider openai`
+  - `imgx config list` now shows all configured provider keys
+
+### Changed
+
+- CLI and MCP server now initialize both Gemini and OpenAI providers at startup
+- `imgx providers` and error messages updated for multi-provider context
+- Help text updated with OpenAI provider info and env var
+
 ## 0.5.2 (2026-02-26)
 
 ### Fixed
@@ -10,6 +35,7 @@
 
 - README: add Claude Desktop MCP configuration (Windows `cmd /c` + macOS/Linux)
 - README: switch all MCP config examples from local `node` path to `npx`
+- README: replace "Version updates" with full release checklist (version bump → build → publish → verify)
 
 ## 0.5.1 (2026-02-26)
 

package/README.md

@@ -2,8 +2,6 @@
 
 AI image generation and editing from the terminal. Provider-agnostic design with capability-based abstraction.
 
-<!-- TODO: Add demo GIF showing generate → edit → edit --last workflow -->
-
 ## Install
 
 ### As a Claude Code plugin
@@ -50,16 +48,25 @@ Requires Node.js 18+.
 
 ## Setup
 
-Get a Gemini API key from [Google AI Studio](https://aistudio.google.com/apikey) (free tier available), then save it:
+Set up at least one provider:
+
+**Gemini** — get a key from [Google AI Studio](https://aistudio.google.com/apikey) (free tier available):
 
 ```bash
-imgx config set api-key YOUR_GEMINI_API_KEY
+imgx config set api-key YOUR_GEMINI_API_KEY --provider gemini
 ```
 
-This stores the key in `~/.config/imgx/config.json` (Linux/macOS) or `%APPDATA%\imgx\config.json` (Windows). Alternatively, set an environment variable:
+**OpenAI** — get a key from [OpenAI Platform](https://platform.openai.com/api-keys):
+
+```bash
+imgx config set api-key YOUR_OPENAI_API_KEY --provider openai
+```
+
+Keys are stored in `~/.config/imgx/config.json` (Linux/macOS) or `%APPDATA%\imgx\config.json` (Windows). Alternatively, set environment variables:
 
 ```bash
 export GEMINI_API_KEY="your-api-key"
+export OPENAI_API_KEY="your-api-key"
 ```
 
 Environment variables take precedence over the config file.
@@ -108,7 +115,8 @@ imgx edit --last -p "Crop to 16:9" -o final.png
 ### Configuration
 
 ```bash
-imgx config set api-key <key>     # Save Gemini API key
+imgx config set api-key <key> --provider gemini   # Save Gemini API key
+imgx config set api-key <key> --provider openai   # Save OpenAI API key
 imgx config set model <name>      # Set default model
 imgx config set output-dir <dir>  # Set default output directory
 imgx config set aspect-ratio 16:9 # Set default aspect ratio
@@ -164,7 +172,8 @@ Environment variables override config file settings.
 
 | Variable | Description |
 |----------|-------------|
-| `GEMINI_API_KEY` | Gemini API key (overrides `imgx config set api-key`) |
+| `GEMINI_API_KEY` | Gemini API key |
+| `OPENAI_API_KEY` | OpenAI API key |
 | `IMGX_PROVIDER` | Default provider |
 | `IMGX_MODEL` | Default model |
 | `IMGX_OUTPUT_DIR` | Default output directory |
@@ -208,7 +217,7 @@ Add to your tool's MCP config. The `env` section is optional if you have already
     "imgx": {
       "command": "npx",
       "args": ["--package=imgx-cli", "-y", "imgx-mcp"],
-      "env": { "GEMINI_API_KEY": "your-api-key" }
+      "env": { "GEMINI_API_KEY": "your-key", "OPENAI_API_KEY": "your-key" }
     }
   }
 }
@@ -226,7 +235,7 @@ Or install as a [Claude Code plugin](#install) for automatic MCP registration.
     "imgx": {
       "command": "npx",
       "args": ["--package=imgx-cli", "-y", "imgx-mcp"],
-      "env": { "GEMINI_API_KEY": "your-api-key" }
+      "env": { "GEMINI_API_KEY": "your-key", "OPENAI_API_KEY": "your-key" }
     }
   }
 }
@@ -242,7 +251,7 @@ macOS / Linux:
     "imgx": {
       "command": "npx",
       "args": ["--package=imgx-cli", "-y", "imgx-mcp"],
-      "env": { "GEMINI_API_KEY": "your-api-key" }
+      "env": { "GEMINI_API_KEY": "your-key", "OPENAI_API_KEY": "your-key" }
     }
   }
 }
@@ -256,7 +265,7 @@ Windows:
     "imgx": {
       "command": "cmd",
       "args": ["/c", "npx", "--package=imgx-cli", "-y", "imgx-mcp"],
-      "env": { "GEMINI_API_KEY": "your-api-key" }
+      "env": { "GEMINI_API_KEY": "your-key", "OPENAI_API_KEY": "your-key" }
     }
   }
 }
@@ -272,11 +281,13 @@ Config file location: `%APPDATA%\Claude\claude_desktop_config.json` (Windows) or
 [mcp_servers.imgx]
 command = "npx"
 args = ["--package=imgx-cli", "-y", "imgx-mcp"]
-env = { GEMINI_API_KEY = "your-api-key" }
+env = { GEMINI_API_KEY = "your-key", OPENAI_API_KEY = "your-key" }
 ```
 
 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.
 
+Only include the API keys for providers you want to use. At least one is required.
+
 ## Architecture
 
 imgx separates **model-independent** and **model-dependent** concerns:
@@ -310,56 +321,7 @@ Each provider declares its supported capabilities. The CLI dynamically enables o
 | Provider | Models | Capabilities |
 |----------|--------|-------------|
 | Gemini | `gemini-3-pro-image-preview`, `gemini-2.5-flash-image` | All 7 capabilities |
-
-## Plugin structure
-
-imgx-cli doubles as an AI coding tool plugin. The repository contains:
-
-```
-.claude-plugin/
-├── plugin.json          # Claude Code plugin manifest
-└── marketplace.json     # Marketplace definition for plugin discovery
-.cursor-plugin/
-└── plugin.json          # Cursor plugin manifest
-.mcp.json                # MCP server config (auto-registered on plugin install)
-skills/
-└── image-generation/
-    ├── SKILL.md         # Skill instructions
-    └── references/
-        └── providers.md # Provider and model reference
-dist/
-├── cli.bundle.js        # Bundled CLI (tracked in git for plugin distribution)
-└── mcp.bundle.js        # Bundled MCP server
-```
-
-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.
-
-### Plugin configuration files
-
-**`.claude-plugin/plugin.json`** — Plugin identity. Fields: `name`, `description`, `version`, `author`. No `category` field (that belongs in `marketplace.json` only).
-
-**`.claude-plugin/marketplace.json`** — Marketplace wrapper. The `source` field must use URL format for self-referencing repositories:
-
-```json
-"source": {
-  "source": "url",
-  "url": "https://github.com/somacoffeekyoto/imgx-cli.git"
-}
-```
-
-**`skills/image-generation/SKILL.md`** — Uses `${CLAUDE_PLUGIN_ROOT}` variable for portable CLI paths. Frontmatter (`name`, `description`) is required for skill registration.
-
-### Version updates
-
-When releasing a new version, update the version string in all locations:
-
-1. `package.json` — npm package version
-2. `src/cli/index.ts` — CLI `--version` output
-3. `.claude-plugin/plugin.json` — Claude Code plugin manifest version
-4. `.claude-plugin/marketplace.json` — Marketplace plugin entry version
-5. `.cursor-plugin/plugin.json` — Cursor plugin manifest version
-
-Then rebuild (`npm run bundle`) and commit `dist/cli.bundle.js` since plugin distribution relies on the git repository.
+| OpenAI | `gpt-image-1` | Generate, edit, aspect ratio, multi-output |
 
 ## Development