Skip to content

Commit b9ef447

Browse files
committed
docs: mention retrieving CustomObjectTranslation
1 parent a2d3738 commit b9ef447

2 files changed

Lines changed: 4 additions & 4 deletions

File tree

README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ This plugin provides a `sf force source read` command to read Metadata using the
99
> [!NOTE]
1010
> This plugin simply returns the unfiltered response from the CRUD-based Metadata API.
1111
12+
In addition to retrieving `Profiles`, this plugin is useful for retrieving `RecordTypes` and `CustomObjectTranslations`.
13+
1214
## Installation
1315

1416
```console
@@ -22,6 +24,7 @@ sf force source read -m "Profile:Admin"
2224
sf force source read -p force-app/main/default/profiles/Admin.profile-meta.xml
2325
sf force source read -m "RecordType:Account.Business"
2426
sf force source read -p force-app/main/default/objects/Account/recordTypes/Business.recordType-meta.xml
27+
sf force source read -m "CustomObjectTranslation:Task-de"
2528
```
2629

2730
## Example
@@ -48,7 +51,3 @@ It returns a kind of "full" Profile independent of source tracking and even cont
4851
> Unfortunately Profiles might include `tabVisibilites` for tabs not available in the org (see [#66](https://github.com/amtrack/sfdx-plugin-source-read/issues/66)).
4952
>
5053
> Without further processing this will cause deployment errrors.
51-
52-
## Disclaimer
53-
54-
Currently this has been tested only for `Profiles` and `RecordTypes`.

src/commands/force/source/read.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ export class SourceReadCommand extends SfCommand<any> {
2121
public static readonly examples = [
2222
`$ <%= config.bin %> <%= command.id %> -m "Profile:Admin"`,
2323
`$ <%= config.bin %> <%= command.id %> -m "RecordType:Account.Business"`,
24+
`$ <%= config.bin %> <%= command.id %> -m "CustomObjectTranslation:Task-de"`,
2425
`$ <%= config.bin %> <%= command.id %> -p force-app/main/default/objects/Account/recordTypes/Business.recordType-meta.xml`,
2526
];
2627

0 commit comments

Comments
 (0)