kotaoue/Fetch Salesforce Field Definitions

Fetch FieldDefinition records from Salesforce Tooling API and save them to a file or directory.

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
formatOutput format. One of: json, csv, json-per-object, csv-per-object, package-xml (for field definitions), entity-json, entity-csv (for entity definitions).yesjson
output_dirDirectory to write output files into. Defaults to docs/ relative to the caller workspace.nodocs
object_scopeObject scope filter. One of: all, system, custom.noall
field_definition_fieldsComma-separated FieldDefinition fields to select. Defaults to all supported fields.no""
entity_definition_fieldsComma-separated EntityDefinition fields to select. Defaults to all supported fields. Only used when format is entity-json or entity-csv.no""
updated_withinOnly fetch objects modified within this duration (e.g. '2days', '12hours', '30min', '1week'). Leave empty to fetch all objects.no""
metadata_api_versionSalesforce Metadata API version to declare in the generated package.xml (e.g. '62.0'). Only used when format is package-xml.no""
sfdx_auth_urlSFDX Auth URL used to authenticate to Salesforce (e.g. from secrets.SFDX_AUTH_URL).yes
sf_usernameSalesforce username to run queries as (e.g. from secrets.SF_USERNAME).yes

no outputs