Migration

sf crud-mdapi read

Migrate from sf force source read to sf crud‐mdapi read.

The new sf crud-mdapi read command replaces sf force source read which is now deprecated and will be removed in the next major release (v2).

Changes

The old sf force source read command was aligned with the already deleted sf force source retrieve command. The new sf crud-mdapi read command aligns the flags and behavior with the sf project retrieve start command.

• new flags: --output-dir and --manifest
• renamed flag: --sourcepath (-p) is now --source-dir (-d)
• changed flag: --metadata can now be specified multiple times instead of only once as comma-separated string
• the global sf flag --flags-dir is now supported
• Metadata like CustomObjectTranslation is now decomposed into multiple files (e.g. .objectTranslation-meta.xml, .fieldTranslation-meta.xml)

Upgrade Instructions

• replace sf force:source:read and sf force source read with sf crud-mdapi read

  Example:

  - sf force:source:read -m Profile:Admin
  + sf crud-mdapi read -m Profile:Admin

• convert comma-separated metadata component names to multiple --metadata flags

  Example:

  - --metadata Profile:Admin,Profile:Standard
  + --metadata Profile:Admin --metadata Profile:Standard

• replace --sourcepath with --source-dir

• replace -p with -d