Skip to main content

Salesforce

Prerequisites

warning

Follow installation instructions here

We strongly advise to create a dedicated user to extract your metadata.

You can follow those instructions to create the catalog user.

Run extraction script

Once the package has been installed, you should be able to run the following command in your terminal:

castor-extract-salesforce [arguments]

Credentials

  • -u, --username: Salesforce username
  • -p, --password: Salesforce password
  • -c, --client-id: Salesforce client id
  • -s, --client-secret: Salesforce client secret
  • -t, --security-token: Salesforce security token
  • -b, --base-url: Salesforce instance URL

Other arguments

  • -o, --output: target folder to store the extracted files

Optional arguments

  • --skip-existing: Skip files already extracted instead of replacing them
info

You can also get help with argument --help