|
1 | 1 | # summary |
2 | 2 |
|
3 | | -Enable source tracking in local auth file. |
| 3 | +Allow Salesforce CLI to track changes in your source files between your project and an org. |
4 | 4 |
|
5 | 5 | # description |
6 | 6 |
|
7 | | -This has no effect on the org. It stores the setting in the CLI's configuration file for this org so that source tracking operations are executed when working with this org. |
| 7 | +Enabling source tracking has no direct effect on the org, it affects only your local environment. Specifically, Salesforce CLI stores the setting in the org's local configuration file so that source tracking operations are executed when working with the org. |
8 | 8 |
|
9 | | -This command will throw an error if the org does not support tracking. |
| 9 | +This command throws an error if the org doesn't support tracking. Examples of orgs that don't support source tracking include Developer Edition orgs, production orgs, Partial Copy sandboxes, and Full sandboxes. |
10 | 10 |
|
11 | 11 | # examples |
12 | 12 |
|
13 | | -Enable tracking on an org using an alias |
| 13 | +- Enable source tracking for an org with alias "myscratch": |
14 | 14 |
|
15 | | -- <%= config.bin %> <%= command.id %> -o someAlias |
| 15 | + <%= config.bin %> <%= command.id %> --target-org myscratch |
16 | 16 |
|
17 | | -Enable tracking on an org using a username |
| 17 | +- Enable source tracking for an org using a username: |
18 | 18 |
|
19 | | -- <%= config.bin %> <%= command.id %> - o [email protected] |
| 19 | + <%= config.bin %> <%= command.id %> - -target-org [email protected] |
20 | 20 |
|
21 | | -Enable tracking on your default org |
| 21 | +- Enable source tracking for your default org: |
22 | 22 |
|
23 | | -- <%= config.bin %> <%= command.id %> |
| 23 | + <%= config.bin %> <%= command.id %> |
24 | 24 |
|
25 | 25 | # success |
26 | 26 |
|
27 | 27 | Enabled source tracking for %s. |
28 | 28 |
|
29 | 29 | # error.TrackingNotAvailable |
30 | 30 |
|
31 | | -This org cannot enable source tracking because the SourceMember object is not available, or you do not have access to it. |
| 31 | +You can't enable source tracking on this org because the SourceMember Tooling API object isn't available, or you don't have access to it. |
32 | 32 |
|
33 | 33 | # error.TrackingNotAvailable.actions |
34 | 34 |
|
35 | | -- If the org is a sandbox, make sure that your production org has Source Tracking enabled in sandboxes. See https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_setup_enable_source_tracking_sandboxes.htm. |
| 35 | +- If the org is a Developer or Developer Pro sandbox, make sure that the associated production org has enabled source tracking in sandboxes. See https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_setup_enable_source_tracking_sandboxes.htm. |
36 | 36 |
|
37 | | -- Make sure that your user can access the SourceMembers table via the tooling API. |
| 37 | +- Make sure that your user can access the SourceMember Tooling API object. |
38 | 38 |
|
39 | | -- If the Org is a production org, source tracking cannot be enabled. |
| 39 | +- You can't enable source tracking on Developer Edition orgs, production orgs, Partial Copy sandboxes, or Full sandboxes. |
0 commit comments