Add dbhost parameter to wp config create command documentation by brentmartinmiller · Pull Request #637 · wp-cli/handbook

brentmartinmiller · 2026-05-21T17:14:18Z

Updated command syntax documentation to include database host parameter and clarified instructions for replacing placeholders.

Summary by CodeRabbit

Documentation
- Clarified that the database host setting is optional and defaults to localhost.
- Added guidance for connection errors on Unix-like systems, including macOS, where the default may use a Unix socket. Instructions now include retrying with an explicit TCP host, such as 127.0.0.1:3306.

Updated command syntax to include database host parameter and clarified instructions for replacing placeholders.

swissspidy · 2026-05-21T17:35:15Z

 In this step, we will generate a config file and set up the database
 credentials for our installation.
-The basic syntax of the command is the following: `wp config create --dbname=<dbname> --dbuser=<dbuser> [--dbpass=<dbpass>]`
+The basic syntax of the command is the following: `wp config create --dbname=<dbname> --dbuser=<dbuser> --dbhost=<dbhost> [--dbpass=<dbpass>]`


dbhost is optional and thus needs square brackets.

FWIW, all the other arguments are optional too nowadays, if using SQLite. See https://github.com/wp-cli/config-command/#wp-config-create

swissspidy · 2026-05-21T17:36:07Z

 ```

-The command above generates the `wp-config.php` file and adds to it the database credentials that you passed. Make sure to replace `your_db_name_here` with the name you want to assign to the database, replace `your_db_user_here` with your database user and type the database password when prompted with the following: `1/10 [--dbpass=<dbpass>]:`
+The command above generates the `wp-config.php` file and adds to it the database credentials that you passed. Make sure to replace `your_db_name_here` with the name you want to assign to the database, replace `your_db_user_here` with your database user, replace `your_db_host` with your database host (e.g., 127.0.0.1:3306) and type the database password when prompted with the following: `1/10 [--dbpass=<dbpass>]:`


We could add a suggestion here to simply check wp config create --help to see how to use it. Less repetitive.

Clarified the command syntax for generating the config file by making the --dbhost parameter optional. Added information about the default behavior of the --dbhost parameter on Unix-like systems.

coderabbitai · 2026-08-09T21:07:52Z

No actionable comments were generated in the recent review.

Recent review info

Run configuration

Source mode: Auto
Repository: Unavailable
Branch: Unavailable
File: No configuration file from this repository applied
Commit: Unavailable
Layers: defaults
Review profile: CHILL
Plan: Advanced
Run ID: 6bc9fc00-3b0b-469b-8b56-d5fae14827b7

Commits

Reviewing files that changed from the base of the PR and between 68b25a6 and c7f45b3.

Files selected for processing: 1

how-to/how-to-install.md

Included review availability: This review used your included allowance. Your plan provides up to 2 included reviews per hour; 1 remain after this review.

Walkthrough

The installation guide updates the wp config create syntax with the optional --dbhost argument. It explains the localhost default, Unix socket behavior, and a TCP host example for connection errors.

Changes: Installation documentation

Layer / File(s)	Summary
Document database host options `how-to/how-to-install.md`	The command syntax includes optional `--dbhost=<dbhost>`. The guide explains password prompting, the `localhost` default, Unix socket behavior, and the TCP fallback.

Priority: Low

Estimated code review effort: 1 (Trivial) | ~3 minutes

Change: Other

Suggested reviewers: swissspidy

Merge Risk: Minimal · up to c7f45

The installation guidance update is safe to merge.

Pre-merge checks: 5

Check name	Status	Explanation
Description Check		Check skipped - CodeRabbit’s high-level summary is enabled.
Title check		The title names the main change: the PR adds the optional --dbhost parameter to the wp config create syntax in the install documentation. The raw summary confirms the only changed file is how-to/how-t…
Docstring Coverage		No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check		Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check		Check skipped because no linked issues were found for this pull request.

Full details: Title check

Explanation

The title names the main change: the PR adds the optional --dbhost parameter to the wp config create syntax in the install documentation. The raw summary confirms the only changed file is how-to/how-to-install.md, which documents this parameter and the TCP host workaround for connection errors. The title is specific, concise, and matches the PR objectives (PR #637).

Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

Finishing Touches

🧪 Generate unit tests (beta)

Create a new PR

Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands.}

coderabbitai

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@how-to/how-to-install.md`:
- Line 27: Update the fenced code block in the installation instructions to
include a shell-session language identifier, using console or shell on its
opening fence, while preserving the block contents.

🪄 Autofix

Fix all unresolved CodeRabbit comments on this PR:

Push a commit to this branch (recommended)
Create a new PR with the fixes

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: f4125a74-6b87-4131-96e2-0f8539247ec4

📥 Commits

Reviewing files that changed from the base of the PR and between 1191ea5 and 68b25a6.

📒 Files selected for processing (1)

how-to/how-to-install.md

coderabbitai · 2026-08-09T21:08:53Z

-The basic syntax of the command is the following: `wp config create --dbname=<dbname> --dbuser=<dbuser> [--dbpass=<dbpass>]`
+The basic syntax of the command is the following: `wp config create --dbname=<dbname> --dbuser=<dbuser> [--dbhost=<dbhost>] [--dbpass=<dbpass>]`

 ```


📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Add a language identifier to the fenced code block.

The block contains a shell session but has no language identifier. Change the opening fence to ```console or ```shell so Markdown linting passes MD040.

🧰 Tools

🪛 markdownlint-cli2 (0.23.2)

[warning] 27-27: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@how-to/how-to-install.md` at line 27, Update the fenced code block in the installation instructions to include a shell-session language identifier, using console or shell on its opening fence, while preserving the block contents.

Source: Linters/SAST tools

Add dbhost parameter to config creation command

f8b103e

Updated command syntax to include database host parameter and clarified instructions for replacing placeholders.

brentmartinmiller requested a review from a team as a code owner May 21, 2026 17:14

brentmartinmiller changed the title ~~Add dbhost parameter to config creation command~~ Add dbhost parameter to wp config create command documentation May 21, 2026

swissspidy reviewed May 21, 2026

View reviewed changes

brentmartinmiller and others added 2 commits May 21, 2026 14:39

Update instructions for wp config create

059ea32

Clarified the command syntax for generating the config file by making the --dbhost parameter optional. Added information about the default behavior of the --dbhost parameter on Unix-like systems.

Merge branch 'main' into patch-1

68b25a6

coderabbitai Bot reviewed Aug 9, 2026

View reviewed changes

schlessera added the scope:documentation label Sep 25, 2026

Merge branch 'main' into patch-1

c7f45b3

Navigation Menu

Repository navigation

Add dbhost parameter to wp config create command documentation - #637

Add dbhost parameter to wp config create command documentation#637
brentmartinmiller wants to merge 4 commits into
wp-cli:mainfrom
brentmartinmiller:patch-1

brentmartinmiller commented May 21, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

swissspidy May 21, 2026

Uh oh!

swissspidy May 21, 2026

Uh oh!

coderabbitai Bot commented Aug 9, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot left a comment

Uh oh!

coderabbitai Bot Aug 9, 2026

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

brentmartinmiller commented May 21, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

swissspidy May 21, 2026

Choose a reason for hiding this comment

Uh oh!

swissspidy May 21, 2026

Choose a reason for hiding this comment

Uh oh!

coderabbitai Bot commented Aug 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai Bot Aug 9, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

brentmartinmiller commented May 21, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Aug 9, 2026 •

edited

Loading