Skip to content

hardis:project:clean:profiles-extract

Description

Command Behavior

Guides administrators through extracting Salesforce profiles, personas, and related metadata into structured CSV/XLSX deliverables.

The command inventories SObjects that contain data, lets the user pick the ones to document, and then produces persona-centric spreadsheets that cover users, personas, relationships, record types, apps, permissions, tabs, fields, and permission sets. The output consolidates everything into both CSV files and a single Excel workbook, making it easy to audit access models or prepare remediation plans.

Key capabilities:

  • Interactive object discovery: Lists queryable objects with records and allows multi-selection.
  • Persona modeling: Lets users define the number of personas and generates cross-object matrices that leverage Excel formulas for faster updates.
  • Comprehensive metadata export: Captures users, record types, apps, permissions, tabs, fields, and permission sets with persona/profile visibility indicators.
  • Profile field access coverage: Retrieves FieldPermissions to surface read/edit status per profile and field.
  • Consolidated reporting: Produces standalone CSVs plus an aggregated XLSX stored in the report directory.
Technical explanations
  • Salesforce connectivity: Uses the requested target org connection from Flags.requiredOrg to fetch metadata and records.
  • Bulk/REST queries: Relies on bulkQuery and standard SOQL to evaluate record counts and pull FieldPermissions, Users, RecordTypes, Applications, Tabs, and PermissionSets.
  • Describe calls: Invokes describeGlobal and describeSObject to enumerate objects and field-level metadata, including picklists and formulas.
  • Prompt-driven input: Utilizes the shared prompts utility to collect object selections and persona counts, ensuring consistent CLI UX.
  • Reporting pipeline: Writes intermediate CSV files via generateCsvFile, stores them under the report directory from getReportDirectory, and finally merges them using createXlsxFromCsvFiles.
  • Logging & diagnostics: Uses uxLog with chalk coloring for progress, warnings, and debug output, integrating with the project-wide logging style.

Parameters

Name Type Description Default Required Options
debug
-d		 boolean Activate debug mode (more logs)
flags-dir option undefined
json boolean Format output as json.
skipauth boolean Skip authentication check when a default username is required
target-org
-o		 option The target Salesforce org to fetch SObjects from.
websocket option Websocket host:port for VsCode SFDX Hardis UI integration

Examples

$ sf hardis:project:clean:profiles-extract

$ sf hardis:project:clean:profiles-extract --target-org my-org