Skip to content

Regenerate README file #138

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 6, 2022
Merged

Regenerate README file #138

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
50 changes: 42 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,15 @@ wp config
Launches system editor to edit the wp-config.php file.

~~~
wp config edit
wp config edit [--config-file=<path>]
~~~

**OPTIONS**

[--config-file=<path>]
Specify the file path to the config file to be edited. Defaults to the root of the
WordPress installation and the filename "wp-config.php".

**EXAMPLES**

# Launch system editor to edit wp-config.php file
Expand All @@ -46,7 +52,7 @@ wp config edit
Deletes a specific constant or variable from the wp-config.php file.

~~~
wp config delete <name> [--type=<type>]
wp config delete <name> [--type=<type>] [--config-file=<path>]
~~~

**OPTIONS**
Expand All @@ -64,6 +70,10 @@ wp config delete <name> [--type=<type>]
- all
---

[--config-file=<path>]
Specify the file path to the config file to be modified. Defaults to the root of the
WordPress installation and the filename "wp-config.php".

**EXAMPLES**

# Delete the COOKIE_DOMAIN constant from the wp-config.php file.
Expand All @@ -76,7 +86,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] [--insecure]
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] [--config-file=<path>] [--insecure]
~~~

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

[--config-file=<path>]
Specify the file path to the config file to be created. Defaults to the root of the
WordPress installation and the filename "wp-config.php".

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

Expand Down Expand Up @@ -160,7 +174,7 @@ the database constants are correct.
Gets the value of a specific constant or variable defined in wp-config.php file.

~~~
wp config get <name> [--type=<type>] [--format=<format>]
wp config get <name> [--type=<type>] [--format=<format>] [--config-file=<path>]
~~~

**OPTIONS**
Expand Down Expand Up @@ -190,6 +204,10 @@ wp config get <name> [--type=<type>] [--format=<format>]
- dotenv
---

[--config-file=<path>]
Specify the file path to the config file to be read. Defaults to the root of the
WordPress installation and the filename "wp-config.php".

**EXAMPLES**

# Get the table_prefix as defined in wp-config.php file.
Expand All @@ -203,7 +221,7 @@ wp config get <name> [--type=<type>] [--format=<format>]
Checks whether a specific constant or variable exists in the wp-config.php file.

~~~
wp config has <name> [--type=<type>]
wp config has <name> [--type=<type>] [--config-file=<path>]
~~~

**OPTIONS**
Expand All @@ -221,6 +239,10 @@ wp config has <name> [--type=<type>]
- all
---

[--config-file=<path>]
Specify the file path to the config file to be checked. Defaults to the root of the
WordPress installation and the filename "wp-config.php".

**EXAMPLES**

# Check whether the DB_PASSWORD constant exists in the wp-config.php file.
Expand All @@ -233,7 +255,7 @@ wp config has <name> [--type=<type>]
Lists variables, constants, and file includes defined in wp-config.php file.

~~~
wp config list [<filter>...] [--fields=<fields>] [--format=<format>] [--strict]
wp config list [<filter>...] [--fields=<fields>] [--format=<format>] [--strict] [--config-file=<path>]
~~~

**OPTIONS**
Expand All @@ -260,6 +282,10 @@ wp config list [<filter>...] [--fields=<fields>] [--format=<format>] [--strict]
[--strict]
Enforce strict matching when a filter is provided.

[--config-file=<path>]
Specify the file path to the config file to be read. Defaults to the root of the
WordPress installation and the filename "wp-config.php".

**EXAMPLES**

# List constants and variables defined in wp-config.php file.
Expand Down Expand Up @@ -318,7 +344,7 @@ wp config path
Sets the value of a specific constant or variable defined in wp-config.php file.

~~~
wp config set <name> <value> [--add] [--raw] [--anchor=<anchor>] [--placement=<placement>] [--separator=<separator>] [--type=<type>]
wp config set <name> <value> [--add] [--raw] [--anchor=<anchor>] [--placement=<placement>] [--separator=<separator>] [--type=<type>] [--config-file=<path>]
~~~

**OPTIONS**
Expand Down Expand Up @@ -365,6 +391,10 @@ wp config set <name> <value> [--add] [--raw] [--anchor=<anchor>] [--placement=<p
- all
---

[--config-file=<path>]
Specify the file path to the config file to be modified. Defaults to the root of the
WordPress installation and the filename "wp-config.php".

**EXAMPLES**

# Set the WP_DEBUG constant to true.
Expand All @@ -377,7 +407,7 @@ 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 [<keys>...] [--force] [--insecure]
wp config shuffle-salts [<keys>...] [--force] [--config-file=<path>] [--insecure]
~~~

**OPTIONS**
Expand All @@ -388,6 +418,10 @@ wp config shuffle-salts [<keys>...] [--force] [--insecure]
[--force]
If an unknown key is requested to be shuffled, add it instead of throwing a warning.

[--config-file=<path>]
Specify the file path to the config file to be modified. Defaults to the root of the
WordPress installation and the filename "wp-config.php".

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

Expand Down