docs: comprehensive, readable README covering all commands#26
Merged
Conversation
Comprehensive rewrite documenting every shipped command (up/down/restart/ watch, status/info/logs/doctor, open targets, db dump/list/restore, wp, seed, the kiqr agent group, init/destroy/completion), plus real-world recipes, configuration, how-it-works, and troubleshooting. Engaging, semi-professional tone. Does not document the unmerged scaffold command. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This was referenced Jun 7, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
A full rewrite of the README so it actually makes people want to use Kiqr — engaging but semi-professional, and complete.
Now documents every shipped command:
up,down,restart,watchstatus,info,logs,doctoropentargets: site / admin / phpmyadmin / plugins / uploads / datadb dump/db list/db restorewp(WP-CLI passthrough) with real examplesseed(demo content: blog / portfolio / woocommerce) + importkiqr agentgroup:status/start/stop/restart/logsinit,destroy,completion(bash/zsh/fish)Plus: a Recipes section (onboarding, version switching, DB time-travel, seeding, starting over), Configuration, How it works (architecture + the agent + lvh.me hostnames), and Troubleshooting.
Notes
scaffold(not on main — the PR was skipped).lint,typecheck, andbuildall pass.🤖 Generated with Claude Code