project retrieve preview
Preview a retrieval to see what will be retrieved from the org, the potential conflicts, and the ignored files.
You must run this command from within a project.
The command outputs a table that describes what will happen if you run the “sf project retrieve start” command. The table lists the metadata components that will be retrieved and deleted. The table also lists the current conflicts between files in your local project and components in the org. Finally, the table lists the files that won’t be retrieved because they’re included in your .forceignore file.
If your org allows source tracking, then this command displays potential conflicts between the org and your local project. Some orgs, such as production org, never allow source tracking. Source tracking is enabled by default on scratch and sandbox orgs; you can disable source tracking when you create the orgs by specifying the –no-track-source flag on the “sf org create scratch|sandbox” commands.
retrieve:metadata:preview
| Flag Name (Long) | Flag Name (Short) | Description |
|---|---|---|
‑‑concise | N/A | Type: Boolean Show only the changes that will be retrieved; omits files that are forceignored. |
‑‑flags‑dir | N/A | Type: Value Import flag values from a directory. |
‑‑ignore‑conflicts | ‑c | Type: Boolean Don’t display conflicts in the preview of the retrieval. This flag applies only to orgs that allow source tracking. It has no effect on orgs that don’t allow it, such as production orgs. |
‑‑json | N/A | Type: Boolean Format output as json. |
‑‑target‑org | ‑o | Type: Value Required Username or alias of the target org. Not required if the target-org configuration variable is already set. |
Preview the retrieve of all changes from your default org:
Preview the retrieve when ignoring any conflicts from an org with alias “my-scratch”: