Skip to content

Commit 54c5dc3

Browse files
Merge pull request #39 from wp-cli/35-update-readme
Update README with docs on new args
2 parents 71cff61 + 60db621 commit 54c5dc3

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Quick links: [Using](#using) | [Installing](#installing) | [Contributing](#contr
1010
## Using
1111

1212
~~~
13-
wp search-replace <old> <new> [<table>...] [--dry-run] [--network] [--all-tables-with-prefix] [--all-tables] [--export[=<file>]] [--export_insert_size=<rows>] [--skip-columns=<columns>] [--include-columns=<columns>] [--precise] [--recurse-objects] [--verbose] [--regex] [--regex-flags=<regex-flags>] [--regex-delimiter=<regex-delimiter>] [--format=<format>] [--report] [--report-changed-only]
13+
wp search-replace <old> <new> [<table>...] [--dry-run] [--network] [--all-tables-with-prefix] [--all-tables] [--export[=<file>]] [--export_insert_size=<rows>] [--skip-columns=<columns>] [--include-columns=<columns>] [--precise] [--recurse-objects] [--verbose] [--regex] [--regex-flags=<regex-flags>] [--regex-delimiter=<regex-delimiter>] [--format=<format>] [--report] [--report-changed-only] [--log[=<file>]] [--before_context=<num>] [--after_context=<num>]
1414
~~~
1515

1616
Searches through all rows in a selection of tables and replaces
@@ -103,7 +103,17 @@ change primary key values.
103103
Produce report. Defaults to true.
104104

105105
[--report-changed-only]
106-
Report changed fields only. Defaults to false.
106+
Report changed fields only. Defaults to false, unless logging, when it defaults to true.
107+
108+
[--log[=<file>]]
109+
Log the items changed. If <file> is not supplied or is "-", will output to STDOUT.
110+
Warning: causes a significant slow down, similar or worse to enabling --precise or --regex.
111+
112+
[--before_context=<num>]
113+
For logging, number of characters to display before the old match and the new replacement. Default 40. Ignored if not logging.
114+
115+
[--after_context=<num>]
116+
For logging, number of characters to display after the old match and the new replacement. Default 40. Ignored if not logging.
107117

108118
**EXAMPLES**
109119

0 commit comments

Comments
 (0)