Skip to main content

A small, privacy-first text-to-image tool: type a prompt, get an image. Bring your own provider.

Project description

🖼️ Limn

to limn: to depict or describe; to paint.

A small, privacy-first tool that turns a text description into an image. Type a prompt, get a picture — no account, minimal options, bring your own provider.

pip install limn

limn "a red bicycle against a brick wall" -o bike.png
  • Type a description → get an image. That's the whole thing.
  • No account, private by default. Your prompts and images are yours. The only network egress is the generation request to the provider you chose.
  • Bring your own provider — self-hosted (SwarmUI / any OpenAI-compatible endpoint) or a cloud key (Google Imagen, OpenAI / DALL·E). Swap with one setting.
  • Minimal by design. Prompt, size, count, seed. Want power? Install something bigger — Limn stays lean.

Quick start

Pick whichever provider you already have:

# Google Imagen (cheap, ~$0.02/image on the Fast tier)
export GEMINI_API_KEY=...
limn "watercolour fox" --provider gemini

# OpenAI Images
export OPENAI_API_KEY=...
limn "watercolour fox" --provider openai

# Self-hosted SwarmUI
export SWARMUI_BASE_URL=https://image.example.org
limn "watercolour fox" --provider swarmui

# Any OpenAI-compatible /v1/images endpoint (LocalAI, ...)
export OPENAI_BASE_URL=http://localhost:8080/v1
limn "watercolour fox" --provider openai-compatible

Then set your provider once so you never pass --provider again:

limn --init-config        # writes a commented ./limn.yaml template
mv limn.yaml ~/.limn.yaml # personal defaults, used everywhere

Usage

limn "a red bicycle against a brick wall" -o bike.png
limn "watercolour fox" --provider swarmui --size 1024x1024 --count 4 --seed 42
Option What
-p, --provider swarmui, openai-compatible, openai, gemini
-m, --model Model name (provider-specific)
-s, --size e.g. 1024x1024 (Imagen maps to the nearest aspect ratio)
-n, --count Number of images (1–10)
--seed Reproducibility, where the backend supports it (SwarmUI)
--negative Negative prompt, where supported (SwarmUI)
-o, --out Output file; default is a slug of the prompt, never overwritten
-c, --config Explicit config file

Config

Layered, later wins: built-in defaults → ~/.limn.yaml (your provider + keys, set once) → ./limn.yaml → CLI flags. Secrets are referenced as ${VAR} so no plaintext keys live in files:

provider: swarmui
size: [1024, 1024]

providers:            # keep several configured; swap with `provider:`
  swarmui:
    base_url: https://image.example.org
    model: juggernautXL_v9
    api_key: "${SWARMUI_TOKEN}"
  gemini:
    model: imagen-4.0-fast-generate-001

Web UI

pip install "limn[serve]"
limn serve                # opens http://127.0.0.1:5466/ in your browser

One page: type a prompt → Generate → the image appears → Save (to disk), Again (regenerate), or Delete. The session gallery lives in the server process's memory only — nothing touches disk until you click Save.

Binds 127.0.0.1 by default. Binding any other host requires a token (--token, or one is generated and printed); useful flags: --port, --out-dir, --no-browser.

Hosting a shared demo

limn serve --demo (or LIMN_DEMO=1) runs a friction-free public instance with guardrails instead of a token: 10 images/hour per IP, provider/model locked to the server config, one ≤1024px image per request, server-side Save disabled (visitors download instead), gallery entries expire after 15 min, and the page shows an "install locally" banner. See docs/demo-deploy.md.

Roadmap

A CLI, a local web UI, and a hostable demo mode (this release), then a Tauri desktop app with bring-your-own-provider.

📄 See SPEC.md for the full specification.

Companion to slide-stream, which shares the same image-provider approach.

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

limn-0.3.0.tar.gz (98.8 kB view details)

Uploaded Source

Built Distribution

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

limn-0.3.0-py3-none-any.whl (25.2 kB view details)

Uploaded Python 3

File details

Details for the file limn-0.3.0.tar.gz.

File metadata

  • Download URL: limn-0.3.0.tar.gz
  • Upload date:
  • Size: 98.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.0

File hashes

Hashes for limn-0.3.0.tar.gz
Algorithm Hash digest
SHA256 75817cc107c7d1821bc55dfc1b2ddaf2126f33394a700c60f1ffc848e6b5fbd5
MD5 45ed8cb16e287329aa95b0a5961482e6
BLAKE2b-256 c4beb1b864bd4b6f49297be346aa48bb938df5062ead3d3a934fd459edad9740

See more details on using hashes here.

File details

Details for the file limn-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: limn-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 25.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.0

File hashes

Hashes for limn-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d4194648c2cd66ebfc4c2566a4aa1a8cce0aba4715f42bb25c328570b57a6bf6
MD5 a70699a3e52d5cd71809658ffc7ac8c0
BLAKE2b-256 3891b40536c5157f0f6a178c6eee13c1c57b54d001316b8a3f0aa5d146802fa0

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