Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
115 changes: 99 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ $ npm install -g @salesforce/cli
$ sf COMMAND
running command...
$ sf (--version|-v)
@salesforce/cli/2.124.0 linux-x64 node-v22.22.0
@salesforce/cli/2.124.1 linux-x64 node-v22.22.0
$ sf --help [COMMAND]
USAGE
$ sf COMMAND
Expand Down Expand Up @@ -203,6 +203,7 @@ See [architecture page](ARCHITECTURE.md) for diagrams of the Salesforce CLI.
- [`sf template generate apex class`](#sf-template-generate-apex-class)
- [`sf template generate apex trigger`](#sf-template-generate-apex-trigger)
- [`sf template generate digital-experience site`](#sf-template-generate-digital-experience-site)
- [`sf template generate flexipage`](#sf-template-generate-flexipage)
- [`sf template generate lightning app`](#sf-template-generate-lightning-app)
- [`sf template generate lightning component`](#sf-template-generate-lightning-component)
- [`sf template generate lightning event`](#sf-template-generate-lightning-event)
Expand Down Expand Up @@ -1889,7 +1890,7 @@ EXAMPLES
$ sf api request graphql --body example.txt --stream-to-file output.txt --include
```

_See code: [@salesforce/plugin-api](https://github.com/salesforcecli/plugin-api/blob/1.3.9/src/commands/api/request/graphql.ts)_
_See code: [@salesforce/plugin-api](https://github.com/salesforcecli/plugin-api/blob/1.3.10/src/commands/api/request/graphql.ts)_

## `sf api request rest [URL]`

Expand Down Expand Up @@ -1998,7 +1999,7 @@ FLAG DESCRIPTIONS
https://github.com/salesforcecli/plugin-api/tree/main/test/test-files/data-project.
```

_See code: [@salesforce/plugin-api](https://github.com/salesforcecli/plugin-api/blob/1.3.9/src/commands/api/request/rest.ts)_
_See code: [@salesforce/plugin-api](https://github.com/salesforcecli/plugin-api/blob/1.3.10/src/commands/api/request/rest.ts)_

## `sf autocomplete [SHELL]`

Expand Down Expand Up @@ -9661,7 +9662,7 @@ FLAG DESCRIPTIONS
directory.
```

_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.7.1/src/commands/template/generate/analytics/template.ts)_
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.8.0/src/commands/template/generate/analytics/template.ts)_

## `sf template generate apex class`

Expand Down Expand Up @@ -9721,7 +9722,7 @@ FLAG DESCRIPTIONS
Supplied parameter values or default values are filled into a copy of the template.
```

_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.7.1/src/commands/template/generate/apex/class.ts)_
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.8.0/src/commands/template/generate/apex/class.ts)_

## `sf template generate apex trigger`

Expand Down Expand Up @@ -9791,7 +9792,7 @@ FLAG DESCRIPTIONS
Supplied parameter values or default values are filled into a copy of the template.
```

_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.7.1/src/commands/template/generate/apex/trigger.ts)_
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.8.0/src/commands/template/generate/apex/trigger.ts)_

## `sf template generate digital-experience site`

Expand Down Expand Up @@ -9841,7 +9842,89 @@ FLAG DESCRIPTIONS
project, defaults to the current directory.
```

_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.7.1/src/commands/template/generate/digital-experience/site.ts)_
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.8.0/src/commands/template/generate/digital-experience/site.ts)_

## `sf template generate flexipage`

Generate a FlexiPage, also known as a Lightning page.

```
USAGE
$ sf template generate flexipage -n <value> -t RecordPage|AppPage|HomePage [--json] [--flags-dir <value>] [-d <value>]
[--api-version <value>] [--label <value>] [--description <value>] [-s <value>] [--primary-field <value>]
[--secondary-fields <value>...] [--detail-fields <value>...]

FLAGS
-d, --output-dir=<value> [default: .] Directory for saving the created files.
-n, --name=<value> (required) Name of the FlexiPage.
-s, --sobject=<value> API name of the Salesforce object; required when creating a RecordPage.
-t, --template=<option> (required) Template type for the FlexiPage.
<options: RecordPage|AppPage|HomePage>
--api-version=<value> Override the api version used for api requests made by this command
--description=<value> Description for the FlexiPage, which provides context about its purpose.
--detail-fields=<value>... Fields to display in the Details tab. Specify multiple fields separated by commas.
Fields are split into two columns. Used only with RecordPage.
--label=<value> Label of this FlexiPage; if not specified, uses the FlexiPage name as the label.
--primary-field=<value> Primary field for the dynamic highlights header; typically 'Name'. Used only with
RecordPage.
--secondary-fields=<value>... Secondary fields shown in the dynamic highlights header. Specify multiple fields
separated by commas. Maximum of 11 fields. Used only with RecordPage.

GLOBAL FLAGS
--flags-dir=<value> Import flag values from a directory.
--json Format output as json.

DESCRIPTION
Generate a FlexiPage, also known as a Lightning page.

FlexiPages are the metadata types associated with a Lightning page. A Lightning page represents a customizable screen
made up of regions containing Lightning components.

You can use this command to generate these types of FlexiPages; specify the type with the --template flag:

- AppPage: A Lightning page used as the home page for a custom app or a standalone application page.
- HomePage: A Lightning page used to override the Home page in Lightning Experience.
- RecordPage: A Lightning page used to override an object record page in Lightning Experience. Requires that you
specify the object name with the --sobject flag.

EXAMPLES
Generate a RecordPage FlexiPage for the Account object in the current directory:

$ sf template generate flexipage --name Account_Record_Page --template RecordPage --sobject Account

Generate an AppPage FlexiPage in the "force-app/main/default/flexipages" directory:

$ sf template generate flexipage --name Sales_Dashboard --template AppPage --output-dir \
force-app/main/default/flexipages

Generate a HomePage FlexiPage with a custom label:

$ sf template generate flexipage --name Custom_Home --template HomePage --label "Sales Home Page"

Generate a RecordPage with dynamic highlights and detail fields:

$ sf template generate flexipage --name Property_Page --template RecordPage --sobject Rental_Property__c \
--primary-field Name --secondary-fields Property_Address__c,City__c --detail-fields \
Name,Property_Address__c,City__c,Monthly_Rent__c,Bedrooms__c

FLAG DESCRIPTIONS
-d, --output-dir=<value> Directory for saving the created files.

The location can be an absolute path or relative to the current working directory. The default is the current
directory.

-n, --name=<value> Name of the FlexiPage.

The name can contain only alphanumeric characters, must start with a letter, and can't end with an underscore or
contain two consecutive underscores.

-s, --sobject=<value> API name of the Salesforce object; required when creating a RecordPage.

For RecordPage FlexiPages, you must specify the associated object API name, such as 'Account', 'Opportunity', or
'Custom_Object__c'. This sets the `sobjectType` field in the FlexiPage metadata.
```

_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.8.0/src/commands/template/generate/flexipage/index.ts)_

## `sf template generate lightning app`

Expand Down Expand Up @@ -9897,7 +9980,7 @@ FLAG DESCRIPTIONS
Supplied parameter values or default values are filled into a copy of the template.
```

_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.7.1/src/commands/template/generate/lightning/app.ts)_
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.8.0/src/commands/template/generate/lightning/app.ts)_

## `sf template generate lightning component`

Expand Down Expand Up @@ -9967,7 +10050,7 @@ FLAG DESCRIPTIONS
Supplied parameter values or default values are filled into a copy of the template.
```

_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.7.1/src/commands/template/generate/lightning/component.ts)_
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.8.0/src/commands/template/generate/lightning/component.ts)_

## `sf template generate lightning event`

Expand Down Expand Up @@ -10023,7 +10106,7 @@ FLAG DESCRIPTIONS
Supplied parameter values or default values are filled into a copy of the template.
```

_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.7.1/src/commands/template/generate/lightning/event.ts)_
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.8.0/src/commands/template/generate/lightning/event.ts)_

## `sf template generate lightning interface`

Expand Down Expand Up @@ -10079,7 +10162,7 @@ FLAG DESCRIPTIONS
Supplied parameter values or default values are filled into a copy of the template.
```

_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.7.1/src/commands/template/generate/lightning/interface.ts)_
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.8.0/src/commands/template/generate/lightning/interface.ts)_

## `sf template generate lightning test`

Expand Down Expand Up @@ -10135,7 +10218,7 @@ FLAG DESCRIPTIONS
Supplied parameter values or default values are filled into a copy of the template.
```

_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.7.1/src/commands/template/generate/lightning/test.ts)_
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.8.0/src/commands/template/generate/lightning/test.ts)_

## `sf template generate project`

Expand Down Expand Up @@ -10241,7 +10324,7 @@ FLAG DESCRIPTIONS
Override the api version used for api requests made by this command
```

_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.7.1/src/commands/template/generate/project/index.ts)_
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.8.0/src/commands/template/generate/project/index.ts)_

## `sf template generate static-resource`

Expand Down Expand Up @@ -10304,7 +10387,7 @@ FLAG DESCRIPTIONS
etc.
```

_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.7.1/src/commands/template/generate/static-resource/index.ts)_
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.8.0/src/commands/template/generate/static-resource/index.ts)_

## `sf template generate visualforce component`

Expand Down Expand Up @@ -10361,7 +10444,7 @@ FLAG DESCRIPTIONS
Supplied parameter values or default values are filled into a copy of the template.
```

_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.7.1/src/commands/template/generate/visualforce/component.ts)_
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.8.0/src/commands/template/generate/visualforce/component.ts)_

## `sf template generate visualforce page`

Expand Down Expand Up @@ -10412,7 +10495,7 @@ FLAG DESCRIPTIONS
The name can be up to 40 characters and must start with a letter.
```

_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.7.1/src/commands/template/generate/visualforce/page.ts)_
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.8.0/src/commands/template/generate/visualforce/page.ts)_

## `sf update [CHANNEL]`

Expand Down
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@salesforce/cli",
"description": "The Salesforce CLI",
"version": "2.124.0",
"version": "2.124.1",
"author": "Salesforce",
"bin": {
"sf": "./bin/run.js",
Expand Down Expand Up @@ -159,7 +159,7 @@
"@salesforce/kit": "^3.1.6",
"@salesforce/plugin-agent": "1.29.0",
"@salesforce/plugin-apex": "3.9.7",
"@salesforce/plugin-api": "1.3.9",
"@salesforce/plugin-api": "1.3.10",
"@salesforce/plugin-auth": "4.1.5",
"@salesforce/plugin-data": "4.0.70",
"@salesforce/plugin-deploy-retrieve": "3.24.9",
Expand All @@ -172,7 +172,7 @@
"@salesforce/plugin-settings": "2.4.56",
"@salesforce/plugin-sobject": "1.4.82",
"@salesforce/plugin-telemetry": "3.7.2",
"@salesforce/plugin-templates": "56.7.1",
"@salesforce/plugin-templates": "56.8.0",
"@salesforce/plugin-trust": "3.7.113",
"@salesforce/plugin-user": "3.6.49",
"@salesforce/sf-plugins-core": "12.2.6",
Expand Down
30 changes: 15 additions & 15 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -2111,7 +2111,7 @@
strip-ansi "6.0.1"
ts-retry-promise "^0.8.1"

"@salesforce/core@^8.18.1", "@salesforce/core@^8.18.7", "@salesforce/core@^8.24.0", "@salesforce/core@^8.25.0", "@salesforce/core@^8.25.1", "@salesforce/core@^8.5.1", "@salesforce/core@^8.8.0", "@salesforce/core@^8.8.1", "@salesforce/core@^8.8.5":
"@salesforce/core@^8.18.1", "@salesforce/core@^8.18.7", "@salesforce/core@^8.24.0", "@salesforce/core@^8.25.0", "@salesforce/core@^8.25.1", "@salesforce/core@^8.5.1", "@salesforce/core@^8.8.0", "@salesforce/core@^8.8.5":
version "8.25.1"
resolved "https://registry.yarnpkg.com/@salesforce/core/-/core-8.25.1.tgz#7646025598bb59b6f95b3656baf8eb0b63a43052"
integrity sha512-Jon0a9uZpp+mNa5PiY+y8dTjaPcsMaxXEkswdzWotrdrZ4g84MmPKSEv+Q/LtXw3uc9i4RmqBJBUXSIvZhgrjg==
Expand Down Expand Up @@ -2173,7 +2173,7 @@
typescript "^5.5.4"
wireit "^0.14.12"

"@salesforce/kit@^3.1.6", "@salesforce/kit@^3.2.0", "@salesforce/kit@^3.2.1", "@salesforce/kit@^3.2.2", "@salesforce/kit@^3.2.3", "@salesforce/kit@^3.2.4":
"@salesforce/kit@^3.1.6", "@salesforce/kit@^3.2.0", "@salesforce/kit@^3.2.2", "@salesforce/kit@^3.2.3", "@salesforce/kit@^3.2.4":
version "3.2.4"
resolved "https://registry.yarnpkg.com/@salesforce/kit/-/kit-3.2.4.tgz#69fb56974685e41d26ae5db30a7261acdc731bb6"
integrity sha512-9buqZ2puIGWqjUFWYNroSeNih4d1s9kdQAzZfutr/Re/JMl6xBct0ATO5LVb1ty5UhdBruJrVaiTg03PqVKU+Q==
Expand Down Expand Up @@ -2243,20 +2243,20 @@
"@salesforce/sf-plugins-core" "^12.2.6"
ansis "^3.3.1"

"@salesforce/plugin-api@1.3.9":
version "1.3.9"
resolved "https://registry.yarnpkg.com/@salesforce/plugin-api/-/plugin-api-1.3.9.tgz#97da29e20bed2e28bdd17c56a39ccc70fd7b5819"
integrity sha512-KCWhOsyd/CgiFVPPdrpI9n4cKdSYhXqgGtZP0p9n/4C1elTr3dfaO1EqIr6iDKhv5FWjTdM6GBtZAaCX06KqvQ==
"@salesforce/plugin-api@1.3.10":
version "1.3.10"
resolved "https://registry.yarnpkg.com/@salesforce/plugin-api/-/plugin-api-1.3.10.tgz#c618ae7808ac00b8ed461b87dea7118478b30d0d"
integrity sha512-20TMn7TPj5oM6t5xhg6iE4+0u9nBpE301ZDODZWxcN8ugk9oUjuUtqvUaKRIkANUEmt1dJvcZzmtPDfzGaS1xg==
dependencies:
"@oclif/core" "^4"
"@salesforce/core" "^8.8.1"
"@salesforce/kit" "^3.2.1"
"@salesforce/sf-plugins-core" "^12"
"@salesforce/core" "^8.25.1"
"@salesforce/kit" "^3.2.4"
"@salesforce/sf-plugins-core" "^12.2.6"
"@salesforce/ts-types" "^2.0.12"
ansis "^3.3.2"
form-data "^4.0.4"
form-data "^4.0.5"
got "^13.0.0"
proxy-agent "^6.4.0"
proxy-agent "^6.5.0"

"@salesforce/plugin-auth@4.1.5":
version "4.1.5"
Expand Down Expand Up @@ -2468,10 +2468,10 @@
"@salesforce/ts-types" "^2.0.12"
debug "^4.4.3"

"@salesforce/plugin-templates@56.7.1":
version "56.7.1"
resolved "https://registry.yarnpkg.com/@salesforce/plugin-templates/-/plugin-templates-56.7.1.tgz#d402b511802002f89f0e6437356d5a78c6b01004"
integrity sha512-L9HV9xkiVICxD48gorPj9K460CFjULXEBrHTJPwFb43NShZX0nMtdxSNNIUnCOF4j+D24U6e0tNZm7AQhEb/+w==
"@salesforce/plugin-templates@56.8.0":
version "56.8.0"
resolved "https://registry.yarnpkg.com/@salesforce/plugin-templates/-/plugin-templates-56.8.0.tgz#63637e323dd3e1a6eabf7910d33dd5f778b33df4"
integrity sha512-z3kqgzEUseNL+MFnV1rcXrE23AvWYqFFJi9qpd6FR/coFI1T/eBm9LtVbRkETeS6sX4FXQYO/HmfiVBCA/+4Qg==
dependencies:
"@salesforce/core" "^8.25.1"
"@salesforce/sf-plugins-core" "^12"
Expand Down
Loading