aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorDanilo M. <danix@danix.xyz>2026-07-08 18:28:58 +0200
committerDanilo M. <danix@danix.xyz>2026-07-08 18:28:58 +0200
commitdf499cf6f45a32f5cfab836eb84fd73a190f0727 (patch)
treea7303dd5c7a4f4f93a669d7cbd1f891e32e58c5d /README.md
parent11d0c92828ae6218bac4c04272db371b0f47750a (diff)
downloadimggen-df499cf6f45a32f5cfab836eb84fd73a190f0727.tar.gz
imggen-df499cf6f45a32f5cfab836eb84fd73a190f0727.zip
Document resident-model default and IMGGEN_WIDTH/HEIGHT
Update README and CLAUDE.md for the two behavior changes: a bare daemon-up prompt run now uses the resident model instead of an interactive menu (menu removed), and default size comes from IMGGEN_WIDTH/IMGGEN_HEIGHT in .env (1280x960 landscape example, 1024x1024 fallback), overridable with -W/-H. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 13 insertions, 5 deletions
diff --git a/README.md b/README.md
index 3be40f6..5e5b255 100644
--- a/README.md
+++ b/README.md
@@ -84,6 +84,8 @@ IMGGEN_OUT=/path/to/output # where PNGs land
IMGGEN_CACHE=/path/to/model-cache # where the ~7.5GB weights are cached
IMGGEN_PORT=8765 # daemon port, localhost-only
IMGGEN_MODEL=sdxl # model loaded on `imggen start`
+IMGGEN_WIDTH=1280 # default image width (multiple of 8)
+IMGGEN_HEIGHT=960 # default image height (multiple of 8)
IMGGEN_UID=1000 # your host uid (id -u)
IMGGEN_GID=100 # your host gid (id -g)
```
@@ -139,15 +141,21 @@ imggen "a foggy harbour at dawn" --steps 30 --seed 42
imggen "portrait of a fox" -m realvis -o fox.png -n "blurry, low quality"
```
-- If the daemon is UP, the prompt goes to it. If the requested `-m` differs
- from the resident model, the daemon swaps first (a few seconds). With no
- `-m` and an interactive terminal, a menu picks the model. A failed swap
- (bad repo, gated repo, OOM) prints the daemon's error and the wrapper
- exits 1.
+- If the daemon is UP, the prompt goes to it. With no `-m`, it uses the
+ currently resident model as-is (the one you chose at `imggen start`), so
+ repeated prompts just iterate on it. Pass `-m KEY` to override; if that
+ differs from the resident model the daemon swaps first (a few seconds). A
+ failed swap (bad repo, gated repo, OOM) prints the daemon's error and the
+ wrapper exits 1.
- If the daemon is DOWN, the wrapper falls back to a one-shot run: it loads
the model, generates, and exits. Slower (pays the ~45s load every time)
but requires no daemon management.
+Size defaults to `IMGGEN_WIDTH`x`IMGGEN_HEIGHT` from `.env` (1280x960 landscape
+in the example), falling back to 1024x1024 if unset. Override per run with
+`-W`/`-H`. Both must be multiples of 8 (SDXL constraint); the daemon and the
+one-shot path reject non-multiples.
+
Output lands in `$IMGGEN_OUT` (from `.env`). Models cache in `$IMGGEN_CACHE`
so the ~7.5GB download happens once.