schema generate field
Generate metadata source files for a new custom field on a specified object.
This command is interactive and must be run in a Salesforce DX project directory. You’re required to specify the field’s label with the “–label” flag. The command uses this label to provide intelligent suggestions for other field properties, such as its API name.
You can generate a custom field on either a standard object, such as Account, or a custom object. In both cases, the source files for the object must already exist in your local project before you run this command. If you create a relationship field, the source files for the parent object must also exist in your local directory. Use the command “sf metadata retrieve -m CustomObject:<object>” to retrieve source files for both standard and custom objects from your org. To create a custom object, run the “sf generate metadata sobject” command or use the Object Manager UI in your Salesforce org.
generate:metadata:field
| Flag Name (Long) | Flag Name (Short) | Description |
|---|---|---|
‑‑flags‑dir | N/A | Type: Value Import flag values from a directory. |
‑‑label | ‑l | Type: Value Required The field’s label. |
‑‑object | ‑o | Type: Value The directory that contains the object’s source files. The object source files in your local project are grouped in a directoy with the same name as the object. Custom object names always end in “__c”. An example of the object directory for the Account standard object is “force-app/main/default/objects/Account” An example custom object directory is “force-app/main/default/objects/MyObject__c” If you don’t specify this flag, the command prompts you to choose from your local objects. |
Create a field with the specified label; the command prompts you for the object:
Specify the local path to the object’s folder: