hardiscreate

Description

Command Behavior

Creates a new Salesforce package (either Managed or Unlocked) in your Dev Hub.

This command streamlines the process of setting up a new Salesforce package, which is a fundamental step for modularizing your Salesforce metadata and enabling continuous integration and delivery practices. It guides you through defining the package's essential properties.

Key functionalities:

• Interactive Package Definition: Prompts you for the package name, the path to its source code, and the package type (Managed or Unlocked).
• Package Type Selection:
  • Managed Packages: Ideal for AppExchange solutions, where code is hidden in subscriber orgs.
  • Unlocked Packages: Suitable for client projects or shared tooling, where code is readable and modifiable in subscriber orgs.
• Package Creation: Executes the Salesforce CLI command to create the package in your connected Dev Hub.

Technical explanations

The command's technical implementation involves:

• Interactive Prompts: Uses the prompts library to gather necessary information from the user, such as packageName, packagePath, and packageType.
• Salesforce CLI Integration: It constructs and executes the sf package create command, passing the user-provided details as arguments.
• execSfdxJson: This utility is used to execute the Salesforce CLI command and capture its JSON output, which includes the newly created package's ID.
• User Feedback: Provides clear messages to the user about the successful creation of the package, including its ID and the associated Dev Hub.

Agent Mode

Use --agent to disable all interactive prompts. Required flags in agent mode:

• --name: Package name (required).
• --path: Package source code path (required).
• --type: Package type, either Managed or Unlocked (default: Unlocked).

All interactive prompts for package name, path, and type are skipped.

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)
flags-dir	option	undefined
json	boolean	Format output as json.
name -n	option	Package name (required in agent mode)
path	option	Package source code path (required in agent mode)
skipauth	boolean	Skip authentication check when a default username is required
target-dev-hub -v	option	undefined
type	option	Package type: Managed or Unlocked (default: Unlocked in agent mode)			Managed Unlocked
websocket	option	Websocket host:port for VsCode SFDX Hardis UI integration

Examples

$ sf hardis:package:create

$ sf hardis:package:create --agent --name "My Package" --path "force-app" --type Unlocked