Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 22 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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://<theme>.<your-computer>.lvh.me:5477`
- 🌐 your site at `http://<theme>.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.
Expand Down Expand Up @@ -119,10 +120,28 @@ Everything below is a real, shipped command. Run `kiqr <command> --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.
Expand Down Expand Up @@ -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

Expand Down
Loading