visualforce Commands

Use the visualforce commands to create Visualforce pages and components.

force:visualforce:component:create

Creates a Visualforce component in the specified directory or the current working directory. The command creates the .component file and associated metadata file.

As of April 20, 2023, we no longer maintain this section of the command reference. Refer to the reference information about the sf-style commands instead, which we update regularly. We keep this reference information about the sfdx-style commands as-is for historical reference only.

Don't worry, this command and its flags continue to work the same as before, and any scripts that use the command won’t break. However, we recommend that you start using the equivalent sf-style visualforce generate component command instead. Here’s how the flags changed between the old and new commands; if a flag isn't listed, the old and new names are the same:

Removed flag: --loglevel. Use the SF_LOG_LEVEL environment variable instead.
Changed flag name: Old name --apiversion. New name: --api-version.
Changed flag name: Old name --outputdir. New name: --output-dir.
Changed flag name: Old name --componentname. New name: --name.

For background information about this change, read this blog post, which describes how we've updated many of the existing sfdx commands to use the improvements we made in sf. We improved this particular command on February 16, 2023.

Warning

Help for force:visualforce:component:create

If not supplied, the apiversion, template, and outputdir use default values.

The outputdir can be an absolute path or relative to the current working directory.

Examples:

1sfdx force:visualforce:component:create -n mycomponent -l mylabel

1sfdx force:visualforce:component:create -n mycomponent -l mylabel -d components

Command Syntax

sfdx force:visualforce:component:create: [--json]; [--loglevel LOGLEVEL]; [-t TEMPLATE]; [-d OUTPUTDIR]; -n COMPONENTNAME; [--apiversion APIVERSION]; -l LABEL

Parameters

--json: Optional; Format output as JSON.; Type: boolean
--loglevel LOGLEVEL: Optional; The logging level for this command invocation. Logs are stored in $HOME/.sf/sf.log.; Type: enum; Permissible values are: trace, debug, info, warn, error, fatal, TRACE, DEBUG, INFO, WARN, ERROR, FATAL; Default value: warn
-t | --template TEMPLATE: Optional; The template to use to create the file. Supplied parameter values or default values are filled into a copy of the template.; Type: string; Permissible values are: DefaultVFComponent; Default value: DefaultVFComponent
-d | --outputdir OUTPUTDIR: Optional; The directory to store the newly created files. The location can be an absolute path or relative to the current working directory. The default is the current directory.; Type: string; Default value: .
-n | --componentname COMPONENTNAME: Required; The Visualforce component name. The name can be up to 40 characters and must start with a letter.; Type: string
--apiversion APIVERSION: Optional; Override the API version used for API requests made by this command.; Type: string
-l | --label LABEL: Required; The label saved in the metadata for the Visualforce component.; Type: string

force:visualforce:page:create

Creates a Visualforce page in the specified directory or the current working directory. The command creates the .page file and associated metadata file.

Don't worry, this command and its flags continue to work the same as before, and any scripts that use the command won’t break. However, we recommend that you start using the equivalent sf-style visualforce generate page command instead. Here’s how the flags changed between the old and new commands; if a flag isn't listed, the old and new names are the same:

Removed flag: --loglevel. Use the SF_LOG_LEVEL environment variable instead.
Changed flag name: Old name --apiversion. New name: --api-version.
Changed flag name: Old name --outputdir. New name: --output-dir.
Changed flag name: Old name --pagename. New name: --name.

Warning

Help for force:visualforce:page:create

If not supplied, the apiversion, template, and outputdir use default values.

The outputdir can be an absolute path or relative to the current working directory.

Examples:

1sfdx force:visualforce:page:create -n mypage -l mylabel

1sfdx force:visualforce:page:create -n mypage -l mylabel -d pages

Command Syntax

sfdx force:visualforce:page:create: [--json]; [--loglevel LOGLEVEL]; [-t TEMPLATE]; [-d OUTPUTDIR]; -n PAGENAME; [--apiversion APIVERSION]; -l LABEL

Parameters

--json: Optional; Format output as JSON.; Type: boolean
--loglevel LOGLEVEL: Optional; The logging level for this command invocation. Logs are stored in $HOME/.sf/sf.log.; Type: enum; Permissible values are: trace, debug, info, warn, error, fatal, TRACE, DEBUG, INFO, WARN, ERROR, FATAL; Default value: warn
-t | --template TEMPLATE: Optional; The template to use to create the file. Supplied parameter values or default values are filled into a copy of the template.; Type: string; Permissible values are: DefaultVFPage; Default value: DefaultVFPage
-d | --outputdir OUTPUTDIR: Optional; The directory to store the newly created files. The location can be an absolute path or relative to the current working directory. The default is the current directory.; Type: string; Default value: .
-n | --pagename PAGENAME: Required; The Visualforce page name. The name can be up to 40 characters and must start with a letter.; Type: string
--apiversion APIVERSION: Optional; Override the API version used for API requests made by this command.; Type: string
-l | --label LABEL: Required; The label saved in the metadata for the Visualforce page.; Type: string

Salesforce CLI Command Reference

visualforce Commands

force:visualforce:component:create

Help for force:visualforce:component:create

Command Syntax

Parameters

force:visualforce:page:create

Help for force:visualforce:page:create

Command Syntax

Parameters