Skip to content

Commit

Permalink
Merge pull request #130 from wp-cli/regenerate-readme
Browse files Browse the repository at this point in the history
Regenerate README file
  • Loading branch information
schlessera authored May 12, 2021
2 parents 688c06c + d1d83a2 commit 46b096e
Showing 1 changed file with 19 additions and 4 deletions.
23 changes: 19 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ wp-cli/config-command

Generates and reads the wp-config.php file.

[![Build Status](https://travis-ci.org/wp-cli/config-command.svg?branch=master)](https://travis-ci.org/wp-cli/config-command)
[![Testing](https://github.com/wp-cli/config-command/actions/workflows/testing.yml/badge.svg)](https://github.com/wp-cli/config-command/actions/workflows/testing.yml)

Quick links: [Using](#using) | [Installing](#installing) | [Contributing](#contributing) | [Support](#support)

Expand Down Expand Up @@ -76,7 +76,7 @@ wp config delete <name> [--type=<type>]
Generates a wp-config.php file.

~~~
wp config create --dbname=<dbname> --dbuser=<dbuser> [--dbpass=<dbpass>] [--dbhost=<dbhost>] [--dbprefix=<dbprefix>] [--dbcharset=<dbcharset>] [--dbcollate=<dbcollate>] [--locale=<locale>] [--extra-php] [--skip-salts] [--skip-check] [--force]
wp config create --dbname=<dbname> --dbuser=<dbuser> [--dbpass=<dbpass>] [--dbhost=<dbhost>] [--dbprefix=<dbprefix>] [--dbcharset=<dbcharset>] [--dbcollate=<dbcollate>] [--locale=<locale>] [--extra-php] [--skip-salts] [--skip-check] [--force] [--insecure]
~~~

Creates a new wp-config.php with database constants, and verifies that
Expand Down Expand Up @@ -132,6 +132,9 @@ the database constants are correct.
[--force]
Overwrites existing files, if present.

[--insecure]
Retry API download without certificate validation if TLS handshake fails. Note: This makes the request vulnerable to a MITM attack.

**EXAMPLES**

# Standard wp-config.php file
Expand Down Expand Up @@ -369,17 +372,29 @@ wp config set <name> <value> [--add] [--raw] [--anchor=<anchor>] [--placement=<p
Refreshes the salts defined in the wp-config.php file.

~~~
wp config shuffle-salts
wp config shuffle-salts [<keys>...] [--force] [--insecure]
~~~

**OPTIONS**

[<keys>...]
One ore more keys to shuffle. If none are provided, this falls back to the default WordPress Core salt keys.

[--force]
If an unknown key is requested to be shuffled, add it instead of throwing a warning.

[--insecure]
Retry API download without certificate validation if TLS handshake fails. Note: This makes the request vulnerable to a MITM attack.

**EXAMPLES**

# Get new salts for your wp-config.php file
$ wp config shuffle-salts
Success: Shuffled the salt keys.

# Add a cache key salt to the wp-config.php file
$ wp config shuffle-salts WP_CACHE_KEY_SALT --force

## Installing

This package is included with WP-CLI itself, no additional installation necessary.
Expand Down Expand Up @@ -412,7 +427,7 @@ Once you've decided to commit the time to seeing your pull request through, [ple

## Support

Github issues aren't for general support questions, but there are other venues you can try: https://wp-cli.org/#support
GitHub issues aren't for general support questions, but there are other venues you can try: https://wp-cli.org/#support


*This README.md is generated dynamically from the project's codebase using `wp scaffold package-readme` ([doc](https://github.com/wp-cli/scaffold-package-command#wp-scaffold-package-readme)). To suggest changes, please submit a pull request against the corresponding part of the codebase.*

0 comments on commit 46b096e

Please sign in to comment.