Skip to content
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

[tsp-client] Update docs #9690

Merged
merged 2 commits into from
Jan 24, 2025
Merged

[tsp-client] Update docs #9690

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cb85509
update docs
cperaltah Jan 24, 2025
2c4cb54
update example
cperaltah Jan 24, 2025
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
10 changes: 9 additions & 1 deletion tools/tsp-client/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,15 @@ Sort an existing swagger specification to be the same content order with TypeSpe

### generate-config-files

Generate the `emitter-package.json` and `emitter-package-lock.json` used for tsp-client commands under the eng/ directory of your current repository. Run this command from the target repository and pass in the path to the package.json file of the emitter you want to use generate the configuration files.
This command generates the default configuration files used by tsp-client. Run this command to generate the `emitter-package.json` and `emitter-package-lock.json` under the **eng/** directory of your current repository.

**Required: Use the `--package-json` flag to specify the path to the package.json file of the emitter you will use to generate client libraries.**

Example:

```
azure-sdk-for-python> tsp-client generate-config-files --package-json <path to @azure-tools/typespec-python emitter clone>\package.json
```

### generate-lock-file

Expand Down
Loading