Skip to content

Commit 3681318

Browse files
author
Matt Wade
committed
Documents options / flags
1 parent e0a40ab commit 3681318

File tree

1 file changed

+45
-0
lines changed

1 file changed

+45
-0
lines changed

README.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ deployed production code.
3636
- [Requirements](#requirements)
3737
- [Installation](#installation)
3838
- [Usage](#usage)
39+
- [CLI Arguments and Options](#cli-arguments-and-options)
3940
- [Non-Interactive Mode Usage](#non-interactive-mode-usage)
4041
- [Interactive Mode Usage](#interactive-mode-usage)
4142
- [Clean Configuration](#clean-configuration)
@@ -90,6 +91,50 @@ pass in the `-i` or `--interactive` flag.
9091

9192
Run `ddp --help` to view more information.
9293

94+
### CLI Arguments and Options
95+
96+
```shell
97+
$ ddp [options] <domain>
98+
```
99+
100+
#### Domain Argument
101+
102+
The domain should be entered with the `http://` or `https://` protocol, and should
103+
not have an ending slash.
104+
105+
```shell
106+
$ ddp http://example.com
107+
```
108+
109+
Note that this argument is required unless in `--interactive` mode.
110+
111+
#### Options
112+
113+
Options / flags should be entered before the domain argument, and are detailed below:
114+
115+
```
116+
-b, --build-dir=build-dir The directory of your built HTML files. Defaults to "build".
117+
118+
-c, --clean-config=clean-config A JSON string, or a file path to a JSON file, to configure how the
119+
HTML should be cleaned before it is diff'd. If "stdin" is passed,
120+
piped input will be used as the clean config. If invalid JSON is
121+
passed, the command exits early. See the DESCRIPTION section for
122+
more information on this.
123+
124+
-h, --help Show CLI help.
125+
126+
-i, --interactive When true, will prompt for inputs it has not explicitly received.
127+
Defaults to false.
128+
129+
-o, --output=output The filename of the HTML diff report. If "stdout" is passed, the
130+
unified diff string is echoed out.
131+
132+
-q, --quiet When true, suppresses any progress messages that otherwise would be
133+
logged out. Defaults to false.
134+
135+
-v, --version Show CLI version.
136+
```
137+
93138
### Non-Interactive Mode Usage
94139

95140
Copy a folder of your entire site and paste it in the current working

0 commit comments

Comments
 (0)