Skip to content

hardis:project:create

Description

Create a new SFDX Project

Command Behavior

Creates and initializes a new Salesforce DX project with sfdx-hardis configuration.

This command automates the setup of a new SFDX project, including git repository initialization, DevHub connection, project naming, development branch configuration, and default auto-clean types.

Technical explanations

The command's technical implementation involves:

  • Git Repository: Ensures a git repository exists or clones one.
  • DevHub Selection: Prompts for the type of development orgs (scratch, sandbox, or both) and connects to DevHub if needed.
  • Project Generation: Creates a new SFDX project using sf project generate if one doesn't already exist.
  • Default Files: Copies default CI/CD configuration files from the package defaults.
  • Configuration: Sets project name, development branch, and auto-clean types in .sfdx-hardis.yml.

Agent Mode

Supports non-interactive execution with --agent:

sf hardis:project:create --agent --orgtype scratch --projectname MyProject --devbranch integration

In agent mode, the following flags are required (no defaults are applied):

  • --orgtype: type of development orgs (scratch, sandbox, or sandboxAndScratch).
  • --projectname: name of the SFDX project.
  • --devbranch: name of the default development branch.

Optional flag:

  • --minimizeprofiles: activates the minimizeProfiles auto-clean type. Only use this if the project is Permission Set-based: it removes from profiles any attribute (object access, field access, etc.) that is already granted by a Permission Set. Omitted by default in agent mode; always activated in interactive mode.

Parameters

Name Type Description Default Required Options
agent boolean Run in non-interactive mode for agents and automation
debug
-d		 boolean Activate debug mode (more logs)
devbranch option Name of the default development branch (required with --agent)
flags-dir option undefined
json boolean Format output as json.
minimizeprofiles boolean Activate the minimizeProfiles auto-clean type. Use only for Permission Set-based projects: removes from profiles any attribute (object/field access, etc.) already granted by a Permission Set. Off by default in agent mode; always on in interactive mode.
orgtype option Type of development orgs: scratch, sandbox, or sandboxAndScratch (required with --agent) scratch
sandbox
sandboxAndScratch
projectname option Name of the SFDX project (required with --agent)
skipauth boolean Skip authentication check when a default username is required
websocket option Websocket host:port for VsCode SFDX Hardis UI integration

Examples

$ sf hardis:project:create

$ sf hardis:project:create --agent --orgtype scratch --projectname MyProject --devbranch integration