diff --git a/README.md b/README.md index fb488974..df1cfcd0 100644 --- a/README.md +++ b/README.md @@ -116,396 +116,730 @@ Congrats, you are debugging! # Commands -A list of the available commands + -#### `sfdx force:apex:class:create` +- [`sf analytics generate template`](#sf-analytics-generate-template) +- [`sf apex generate class`](#sf-apex-generate-class) +- [`sf apex generate trigger`](#sf-apex-generate-trigger) +- [`sf lightning generate app`](#sf-lightning-generate-app) +- [`sf lightning generate component`](#sf-lightning-generate-component) +- [`sf lightning generate event`](#sf-lightning-generate-event) +- [`sf lightning generate interface`](#sf-lightning-generate-interface) +- [`sf lightning generate test`](#sf-lightning-generate-test) +- [`sf project generate`](#sf-project-generate) +- [`sf static-resource generate`](#sf-static-resource-generate) +- [`sf visualforce generate component`](#sf-visualforce-generate-component) +- [`sf visualforce generate page`](#sf-visualforce-generate-page) -create an Apex class +## `sf analytics generate template` + +Generate a simple Analytics template. ``` USAGE - $ sfdx force:apex:class:create -n [-d ] [-t ] [--apiversion ] [--json] [--loglevel - trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + $ sf analytics generate template -n [--json] [-d ] [--api-version ] -OPTIONS - -d, --outputdir=outputdir folder for saving the created files +FLAGS + -d, --output-dir= [default: .] Directory for saving the created files. + -n, --name= (required) Name of the Analytics template. + --api-version= Override the api version used for api requests made by this command - -n, --classname=classname(required) name of the generated Apex class +GLOBAL FLAGS + --json Format output as json. - -t, --template=ApexException|ApexUnitTest|DefaultApexClass|InboundEmailService [default: DefaultApexClass] template - to use for file creation +DESCRIPTION + Generate a simple Analytics template. - --apiversion=apiversion override the api version used for - api requests made by this command + The metadata files associated with the Analytics template must be contained in a parent directory called + "waveTemplates" in your package directory. Either run this command from an existing directory of this name, or use the + --output-dir flag to generate one or point to an existing one. - --json format output as json +ALIASES + $ sf force analytics template create - --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for - this command invocation +EXAMPLES + Generate the metadata files for a simple Analytics template file called myTemplate in the + force-app/main/default/waveTemplates directory: -DESCRIPTION - 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. + $ sf analytics generate template --name myTemplate --output-dir force-app/main/default/waveTemplates -EXAMPLES - $ sfdx force:apex:class:create -n MyClass - $ sfdx force:apex:class:create -n MyClass -d classes +FLAG DESCRIPTIONS + -d, --output-dir= 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. ``` -_See code: [src/commands/force/apex/class/create.ts](https://github.com/salesforcecli/plugin-templates/blob/master/src/commands/force/apex/class/create.ts)_ +_See code: [src/commands/analytics/generate/template.ts](https://github.com/salesforcecli/plugin-templates/blob/main/src/commands/analytics/generate/template.ts)_ -#### `sfdx force:apex:trigger:create` +## `sf apex generate class` -create an Apex trigger +Generate an Apex class. ``` USAGE - $ sfdx force:apex:trigger:create -n [-d ] [-e ] [-s ] [-t ] [--apiversion - ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + $ sf apex generate class -n [--json] [-t ApexException|ApexUnitTest|DefaultApexClass|InboundEmailService] [-d + ] [--api-version ] -OPTIONS - -d, --outputdir=outputdir folder for saving the created files +FLAGS + -d, --output-dir= [default: .] Directory for saving the created files. + -n, --name= (required) Name of the generated Apex class. + -t, --template=