Skip to main content

Planner + CLI for managing durable image slots and variants

Project description

Image Slots Toolkit

This repository provides a complete workflow for managing durable image slots with generated variants. It includes:

  • A remote FastMCP planner (server.py) that helps agents gather missing context and build CLI commands without touching local paths.
  • A local CLI executor (imgen) that generates variants via the OpenRouter HTTP API (defaulting to Google Gemini 2.5 Flash Image Preview), writes session manifests, promotes variants atomically, and surfaces structured JSON for agents.
  • A lightweight gallery server (imgen gallery serve) for browsing sessions and switching variants from the browser.

Getting started

  1. Create a virtual environment and install dependencies from the lockfile:

    python -m venv .venv
    source .venv/bin/activate
    uv pip install -r requirements.txt
    
  2. Install the package in editable mode if you want the imgen console script locally:

    uv pip install -e .
    

    (Once published to PyPI you can install globally via pipx install imgen-cli.)

  3. Confirm the CLI is available:

imgen --help

Project setup

Initialize a project once to create .imagemcp/config.json and register the target asset directory:

imgen init \
  --project-root /path/to/your/project \
  --target-root public/img

After this step, all CLI commands auto-detect the project root (even when called from subdirectories) and write assets under the configured target folder.

CLI usage

Generate variants for a slot and receive structured JSON:

imgen gen \
  --slot hero \
  --target-root public/img \
  --prompt "Launch hero concept" \
  --n 3 \
  --json
  • Variants are written under <targetRoot>/.sessions/<slot>_<sessionId>/ with a manifest (session.json).
  • The first variant is auto-promoted to <targetRoot>/<slot>.png using atomic writes.
  • CLI output includes the selected index, target path, session directory, warnings, and a localhost gallery URL.

Switch to a different variant later:

imgen select \
  --target-root public/img \
  --slot hero \
  --session hero-20250101_abcdef \
  --index 2 \
  --json

Inspect slots and sessions:

imgen slots list --target-root public/img
imgen sessions list --target-root public/img --slot hero
imgen sessions info --target-root public/img --slot hero --session hero-20250101_abcdef

AI SDK bridge

The CLI calls OpenRouter directly over HTTPS and defaults to the google/gemini-2.5-flash-image-preview model. Configure OPENROUTER_API_KEY in .env before running imgen gen. Optional headers (like IMAGEMCP_OPENROUTER_HTTP_REFERER and IMAGEMCP_OPENROUTER_APP_TITLE) and concurrency (IMAGEMCP_OPENROUTER_MAX_WORKERS) can also be set via environment variables. If you prefer calling Google directly, set --provider google (or IMAGEMCP_DEFAULT_PROVIDER=google)—note that the pure-Python generator currently supports OpenRouter only.

Gallery server

Run the local gallery to browse variants from the browser:

imgen gallery serve --target-root public/img --port 8765 --open-browser

The gallery binds to localhost and allows selecting variants from any session. The CLI always prints the expected gallery URL so agents can surface it to users.

FastMCP planner

server.py exposes two planning tools for agents:

  • collect_context_questions: identifies missing slot context, provides sensible defaults, and highlights provider constraints (size vs aspect ratio, seeds, etc.).
  • plan_image_job: returns an AI generation plan along with a CLI command template and stdin payload ready for execution by the local CLI.

Run the planner locally during development:

python server.py

Testing

Install the test extras and run pytest:

uv pip install -e .[dev]
pytest

The tests cover end-to-end CLI behaviour (generation + selection) and planning logic.

Notes

  • The default generator uses OpenRouter's HTTP API with the google/gemini-2.5-flash-image-preview model. Provide OPENROUTER_API_KEY in .env. To call Google directly, switch the --provider flag or set IMAGEMCP_DEFAULT_PROVIDER=google (direct Google support is not yet implemented in the pure-Python generator).
  • You can still opt into the local mock generator for offline testing via --generator mock.
  • All file operations enforce project-root scoping and use atomic promotion to keep dev servers stable.
  • Update .env.example if new environment variables are introduced. Secrets must never be committed.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

imgen_cli-0.1.4.tar.gz (44.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

imgen_cli-0.1.4-py3-none-any.whl (45.3 kB view details)

Uploaded Python 3

File details

Details for the file imgen_cli-0.1.4.tar.gz.

File metadata

  • Download URL: imgen_cli-0.1.4.tar.gz
  • Upload date:
  • Size: 44.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.20

File hashes

Hashes for imgen_cli-0.1.4.tar.gz
Algorithm Hash digest
SHA256 3bde1053a2f76847ced053aa3233706767bf3f749dee1ce31adb072818fc41bb
MD5 68b14aa29447457102839cc2d3ce3c3b
BLAKE2b-256 611b97119072deb39fee793e97df00852992912e96b8bd8d8e4ea3c31f2e2906

See more details on using hashes here.

File details

Details for the file imgen_cli-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: imgen_cli-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 45.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.20

File hashes

Hashes for imgen_cli-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 f4b58cbcecf364460d9e30ed660ccabb70f92455e0c825bc059fc3c7c76be665
MD5 1027a38b47fbcaf67dc1a60e7e45479c
BLAKE2b-256 d1339a5b74e9233b4597941c2bc86f902293c872a387f28bbe1efcd0c154e8da

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page