From 3304b5a847bbde4882c2fb1ec69be8bf635c86d9 Mon Sep 17 00:00:00 2001 From: kjellbergzoey Date: Mon, 8 Jun 2026 21:11:22 +0000 Subject: [PATCH 1/2] docs: highlight the Mailpit email catcher in the README Mailpit (kiqr open mail) shipped in #29 but the README still listed a 'mail catcher' as a future goodie. Feature it properly: a dedicated 'Catch every email' section, an open-targets row, a quick-start bullet, and an updated agent section. Also fixes a stale hostname example (..lvh.me -> .lvh.me). Co-Authored-By: Claude Opus 4.8 --- README.md | 23 +++++++++++++++++++++-- 1 file changed, 21 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 651703f..d614206 100644 --- a/README.md +++ b/README.md @@ -75,9 +75,10 @@ kiqr up First run in a fresh theme? Kiqr notices there's no project config yet, recognizes your theme, and offers to set everything up โ€” no `init` ceremony required. When it's done you get: -- ๐ŸŒ your site at `http://..lvh.me:5477` +- ๐ŸŒ your site at `http://.lvh.me:5477` - ๐Ÿ” a one-click auto-login to `/wp-admin` - ๐Ÿ—„๏ธ phpMyAdmin, also one click +- ๐Ÿ“ฌ every email your site sends, caught in an inbox โ€” `kiqr open mail` - ๐Ÿ’พ a database and uploads folder that survive restarts Edit a file, hit refresh (or run `kiqr watch` and don't even do that). Welcome to the good life. @@ -119,10 +120,28 @@ Everything below is a real, shipped command. Run `kiqr --help` any tim | `kiqr open` | Your site | | `kiqr open admin` | `/wp-admin`, auto-logged-in (no password tango) | | `kiqr open phpmyadmin` | phpMyAdmin, auto-logged-in | +| `kiqr open mail` | The Mailpit inbox โ€” every email your site tried to send | | `kiqr open plugins` | The local plugins folder | | `kiqr open uploads` | The local uploads folder | | `kiqr open data` | The project's local data directory | +### ๐Ÿ“ฌ Catch every email (Mailpit) + +WordPress sends a *lot* of mail โ€” password resets, order receipts, form +notifications โ€” and in local dev it usually vanishes into the void (or worse, +fires off to a real customer). Kiqr catches all of it. + +The kiqr agent runs [Mailpit](https://mailpit.axllent.org), and every message +any project tries to send lands in a clean web inbox โ€” zero SMTP config, no +plugin to install: + +```bash +kiqr open mail # โ†’ http://mail.lvh.me:5477 +``` + +It just works the moment your site is up, and it's **development-only** โ€” your +deployed site keeps using its real mailer, untouched. + ### ๐Ÿ—„๏ธ Database backups (`kiqr db`) Snapshots of your local database, compressed and tagged so you can roll back after that "experimental" migration. @@ -173,7 +192,7 @@ The shared reverse proxy + splash page that route every Kiqr site live as one pe | `kiqr agent restart` | Restart it. | | `kiqr agent logs` | Stream its logs. | -`kiqr down` and `kiqr destroy` leave the agent alone on purpose โ€” it's infrastructure, not project clutter. (It's also where future shared goodies will live: a dashboard, a mail catcher, the collaboration tunnel.) +`kiqr down` and `kiqr destroy` leave the agent alone on purpose โ€” it's infrastructure, not project clutter. It already hosts the [Mailpit](https://mailpit.axllent.org) email catcher (`kiqr open mail`), with more shared goodies like a dashboard on the roadmap. ### ๐Ÿงน Setup & housekeeping From 56725b9a7e4121e8add40c0c2ae725c331b378ef Mon Sep 17 00:00:00 2001 From: kjellbergzoey Date: Mon, 8 Jun 2026 21:12:05 +0000 Subject: [PATCH 2/2] docs: fix stale hostname in the hero example too Co-Authored-By: Claude Opus 4.8 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d614206..061c5a3 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ Kiqr is the deal: you stay in your theme repo, run one command, and a real WordP cd my-glorious-theme kiqr up # โ˜• ...a few seconds later... -# โ†’ http://my-glorious-theme.your-laptop.lvh.me:5477 +# โ†’ http://my-glorious-theme.lvh.me:5477 ``` That's the whole pitch. Keep reading and we'll prove it.