Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/muenzpraeger/sfdx-plugin
https://github.com/muenzpraeger/sfdx-plugin
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/muenzpraeger/sfdx-plugin
- Owner: muenzpraeger
- Archived: true
- Created: 2018-04-23T10:01:20.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-08-02T06:23:00.000Z (over 3 years ago)
- Last Synced: 2024-11-01T06:12:22.637Z (about 2 months ago)
- Language: TypeScript
- Size: 13.4 MB
- Stars: 40
- Watchers: 7
- Forks: 6
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-sfdx-plugins - muenzpraeger/sfdx-plugin
README
# sfdx-plugin
A plugin for the Salesforce CLI built by René Winkelmeyer.
[](https://www.npmjs.com/package/@muenzpraeger/sfdx-plugin)
[](https://www.npmjs.com/package/@muenzpraeger/sfdx-plugin)
[](https://github.com/muenzpraeger/sfdx-plugin/blob/master/package.json)
## Installation into the Salesforce CLI
Install the plugin into your Salesforce CLI using this command:
```sh-session
$ sfdx plugins:install @muenzpraeger/sfdx-plugin
```
You can check a successful installation with `sfdx plugins`. Updates are applied when executing `sfdx plugins:update`.
## Commands
- [sfdx mzpr:source:api:set](#sfdx-muenzpraegersourceapiset)
- [sfdx mzpr:source:cleanupaura](#sfdx-muenzpraegersourcecleanupaura)
- [sfdx mzpr:swagger:import](#sfdx-muenzpraegerswaggerimport)
## sfdx mzpr:source:api:set
Upgrades the current project and all metadata to the latest API version
```
USAGE
$ sfdx mzpr:source:api:set
OPTIONS
-a, --apiversion=apiversion specify the API version (defaults to API version of your DevHub)
-h, --help show CLI help
-v, --targetdevhubusername=targetdevhubusername username or alias for the dev hub org; overrides default dev hub org
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal) logging level for this command invocation
EXAMPLES
$ sfdx mzpr:source:api:set
Reading content of package directories
45 files have been set to API version 42.0.
$ sfdx mzpr:source:api:set -a 41.0
Reading content of package directories
45 files have been set to API version 41.0.
```
## sfdx mzpr:source:cleanupaura
Removes all boilerplate Aura related files that have not been modified
```
USAGE
$ sfdx mzpr:source:cleanupaura
OPTIONS
-h, --help show CLI help
-p, --noprompt no prompt for confirm deletion
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal) logging level for this command invocation
EXAMPLES
$ sfdx mzpr:source:cleanupaura
Make sure that your git commits are up-to-date before you proceed. Do you want to delete boilerplate Aura
related files that have not been modified? (y/N) y
Reading content of package directories
36 non-modified boilerplate Aura files have been deleted in package directory 'force-app'.
$ sfdx mzpr:source:cleanupaura -p
Reading content of package directories
36 non-modified boilerplate Aura files have been deleted in package directory 'force-app'.
```
## sfdx mzpr:swagger:import
Auto-generate Apex classes from Swagger/OpenAPI files.
```
USAGE
$ sfdx mzpr:swagger:import
OPTIONS
-a, --apiversion=apiversion specify the API version (defaults to API version of your DevHub)
-d, --outputdir=outputdir (required) local folder for storing the created files.
-f, --force overwrites existing files
-h, --help show CLI help
-p, --path=path (required) URL or local file path for Swagger definition file.
-v, --targetdevhubusername=targetdevhubusername username or alias for the dev hub org; overrides default dev hub org
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal) logging level for this command invocation
EXAMPLE
$ sfdx mzpr:swagger:import -d . -p http://petstore.swagger.io/v2/swagger.json
Apex classes have been generated.
```