Skip to content

Commit fd20df1

Browse files
committed
[README.md] Verbatim real CLI help text
1 parent d32778e commit fd20df1

File tree

1 file changed

+80
-0
lines changed

1 file changed

+80
-0
lines changed

README.md

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,3 +110,83 @@ at your option.
110110
Unless you explicitly state otherwise, any contribution intentionally submitted
111111
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
112112
dual licensed as above, without any additional terms or conditions.
113+
114+
## CLI Help
115+
116+
```
117+
$ cdd-python --help
118+
usage: cdd-python [-h] [--version]
119+
{from_openapi,to_openapi,sync,to_docs_json,server_json_rpc}
120+
...
121+
122+
CDD Python Client generator and extractor.
123+
124+
positional arguments:
125+
{from_openapi,to_openapi,sync,to_docs_json,server_json_rpc}
126+
from_openapi Generate code from OpenAPI
127+
to_openapi Extract OpenAPI from code
128+
sync Sync a directory containing client.py, mock_server.py,
129+
test_client.py, cli_main.py
130+
to_docs_json Generate JSON documentation
131+
server_json_rpc Run JSON-RPC server
132+
133+
options:
134+
-h, --help show this help message and exit
135+
--version show program's version number and exit
136+
```
137+
138+
### `from_openapi`
139+
140+
```
141+
$ cdd-python from_openapi --help
142+
usage: cdd-python from_openapi [-h] [-i INPUT | --input-dir INPUT_DIR]
143+
[-o OUTPUT] [--no-github-actions]
144+
[--no-installable-package]
145+
{to_sdk,to_sdk_cli,to_server} ...
146+
147+
positional arguments:
148+
{to_sdk,to_sdk_cli,to_server}
149+
150+
options:
151+
-h, --help show this help message and exit
152+
-i INPUT, --input INPUT
153+
Path to OpenAPI JSON file
154+
--input-dir INPUT_DIR
155+
Directory containing OpenAPI specs
156+
-o OUTPUT, --output OUTPUT
157+
Output directory
158+
--no-github-actions Do not generate GitHub Actions
159+
--no-installable-package
160+
Do not generate installable package scaffolding
161+
```
162+
163+
### `to_openapi`
164+
165+
```
166+
$ cdd-python to_openapi --help
167+
usage: cdd-python to_openapi [-h] -i INPUT [-o OUTPUT]
168+
169+
options:
170+
-h, --help show this help message and exit
171+
-i INPUT, --input INPUT
172+
Path to Python source file or directory
173+
-o OUTPUT, --output OUTPUT
174+
Output OpenAPI JSON file
175+
```
176+
177+
### `to_docs_json`
178+
179+
```
180+
$ cdd-python to_docs_json --help
181+
usage: cdd-python to_docs_json [-h] -i INPUT [--no-imports] [--no-wrapping]
182+
[-o OUTPUT]
183+
184+
options:
185+
-h, --help show this help message and exit
186+
-i INPUT, --input INPUT
187+
Path or URL to the OpenAPI specification
188+
--no-imports Omit the imports field
189+
--no-wrapping Omit the wrapper fields
190+
-o OUTPUT, --output OUTPUT
191+
Output JSON file (defaults to stdout)
192+
```

0 commit comments

Comments
 (0)