Skip to content

Commit 81c2be7

Browse files
authored
Update README.md
1 parent cb32c30 commit 81c2be7

File tree

1 file changed

+3
-8
lines changed

1 file changed

+3
-8
lines changed

README.md

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -41,16 +41,11 @@ Then, if you want tab completion: `openapi-python-client --install-completion`
4141
`openapi-python-client generate --url https://my.api.com/openapi.json`
4242

4343
This will generate a new client library named based on the title in your OpenAPI spec. For example, if the title
44-
of your API is "My API", the expected output will be "my-api-client". If a folder already exists by that name, you'll
45-
get an error.
44+
of your API is "My API", the expected output will be "my-api-client". You can change that directory name with the config file (documented below) or with `--output-path`.
4645

47-
If you have an `openapi.json` file available on disk, in any CLI invocation you can build off that instead by replacing `--url` with a `--path`:
46+
If the directory to generate already exists, you'll get an error unless you use `--overwrite`.
4847

49-
`openapi-python-client generate --path location/on/disk/openapi.json`
50-
51-
### Update an existing client
52-
53-
`openapi-python-client update --url https://my.api.com/openapi.json`
48+
You can use an OpenAPI file instead of a URL like `openapi-python-client generate --path location/on/disk/openapi.json`.
5449

5550
### Using custom templates
5651

0 commit comments

Comments
 (0)