Config Reference

Config Reference

Config files are JSON. Use configs/config_example.json as a template. Path with --config configs/yourfile.json.

Keys

Key	Type	Description
instance	string	Salesforce instance URL, e.g. https://yourorg.my.salesforce.com or https://yourorg--sandbox.my.salesforce.com
client_id	string	Connected App Consumer Key
client_secret	string	Connected App Consumer Secret (if required by the app)
callback_port	number	Local port for OAuth callback (default 8080). Connected App callback URL must be http://localhost:8080/callback (or the host/port you use).
callback_host	string	Host for callback (e.g. localhost).
mode	string	"quick" or "full". quick: default object set (Lead, Account, Contact, Case, Opportunity) when objects is empty. full: all relevant objects when objects is empty.
objects	array	Object API names to analyze. Empty = use mode defaults. Example: ["Account","Contact","CustomObj__c"].
object_scope	array	e.g. ["all"] or ["standard","custom"] to limit which objects are considered.
pii_fields	array	Field identifiers to mask in logs (e.g. ["Contact.Email","Account.PersonEmail"]). Built-in masking also applies to common PII types.
exclusion_fields	array	Fields to exclude from “least used” / low-usage views (e.g. known system or legacy fields).
exclusion_objects	array	Object API names to exclude from analysis (not described or queried). The tool excludes many standard objects by default (see Object Exclusions); add names here for org-specific exclusions (e.g. from temp/failed_objects.json after a run).

Example

{
  "instance": "https://myorg.my.salesforce.com",
  "client_id": "your_consumer_key",
  "client_secret": "your_consumer_secret",
  "callback_port": 8080,
  "callback_host": "localhost",
  "mode": "quick",
  "objects": [],
  "object_scope": ["all"],
  "pii_fields": [],
  "exclusion_fields": [],
  "exclusion_objects": []
}

• For a quick run with defaults, set mode to "quick" and objects to [].
• To run on specific objects only, set objects to e.g. ["Account","Contact"] (mode still applies when objects is empty).
• exclusion_fields – Excluded fields are omitted from CSV/JSON output.
• exclusion_objects – Excluded objects are not described or queried and do not appear in output. See Object Exclusions for default exclusions and temp/failed_objects.json.