plugin-permissions v0.1.3
plugin-permissions
Using the template
This repository provides a template for creating a plugin for the Salesforce CLI. To convert this template to a working plugin:
- Please get in touch with the Platform CLI team. We want to help you develop your plugin.
Generate your plugin:
sf plugins install dev sf dev generate plugin git init -b main git add . && git commit -m "chore: initial commit"
Create your plugin's repo in the salesforcecli github org
- When you're ready, replace the contents of this README with the information you want.
Learn about sf
plugins
Salesforce CLI plugins are based on the oclif plugin framework. Read the plugin developer guide to learn about Salesforce CLI plugin development.
This repository contains a lot of additional scripts and tools to help with general Salesforce node development and enforce coding standards. You should familiarize yourself with some of the node developer packages used by Salesforce.
Additionally, there are some additional tests that the Salesforce CLI will enforce if this plugin is ever bundled with the CLI. These test are included by default under the posttest
script and it is required to keep these tests active in your plugin if you plan to have it bundled.
Tooling
- @salesforce/core
- @salesforce/kit
- @salesforce/sf-plugins-core
- @salesforce/ts-types
- @salesforce/ts-sinon
- @salesforce/dev-config
- @salesforce/dev-scripts
Hooks
For cross clouds commands, e.g. sf env list
, we utilize oclif hooks to get the relevant information from installed plugins.
This plugin includes sample hooks in the src/hooks directory. You'll just need to add the appropriate logic. You can also delete any of the hooks if they aren't required for your plugin.
Everything past here is only a suggestion as to what should be in your specific plugin's description
This plugin is bundled with the Salesforce CLI. For more information on the CLI, read the getting started guide.
We always recommend using the latest version of these commands bundled with the CLI, however, you can install a specific version or tag if needed.
Install
sf plugins install plugin-permissions@x.y.z
Issues
Please report any issues at https://github.com/forcedotcom/cli/issues
Contributing
- Please read our Code of Conduct
- Create a new issue before starting your project so that we can keep track of what you are trying to add/fix. That way, we can also offer suggestions or let you know if there is already an effort in progress.
- Fork this repository.
- Build the plugin locally
- Create a topic branch in your fork. Note, this step is recommended but technically not required if contributing using a fork.
- Edit the code in your fork.
- Write appropriate tests for your changes. Try to achieve at least 95% code coverage on any new code. No pull request will be accepted without unit tests.
- Sign CLA (see CLA below).
- Send us a pull request when you are done. We'll review your code, suggest any needed changes, and merge it in.
CLA
External contributors will be required to sign a Contributor's License Agreement. You can do so by going to https://cla.salesforce.com/sign-cla.
Build
To build the plugin locally, make sure to have yarn installed and run the following commands:
# Clone the repository
git clone git@github.com:salesforcecli/plugin-permissions
# Install the dependencies and compile
yarn && yarn build
To use your plugin, run using the local ./bin/dev
or ./bin/dev.cmd
file.
# Run using local run file.
./bin/dev hello world
There should be no differences when running via the Salesforce CLI or using the local run file. However, it can be useful to link the plugin to do some additional testing or run your commands from anywhere on your machine.
# Link your plugin to the sf cli
sf plugins link .
# To verify
sf plugins
Commands
sf p ls ps
sf p ls psg
sf p ls uap
sf permissions list groups
sf permissions list permission-set-groups
sf permissions list permission-sets
sf permissions list policies
sf permissions list sets
sf permissions list user-access-policies
sf permissions ls groups
sf permissions ls policies
sf permissions ls ps
sf permissions ls psg
sf permissions ls sets
sf permissions ls uap
sf p ls ps
Lists all the permission sets in a project.
USAGE
$ sf p ls ps [--json]
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Lists all the permission sets in a project.
When run inside a SFDX project, it finds all the permission sets in each of the package directories specified in the
`sfdx-project.json` file.
ALIASES
$ sf permissions list permission-sets
$ sf permissions ls sets
$ sf permissions ls ps
$ sf p ls ps
EXAMPLES
$ sf p ls ps
sf p ls psg
Lists all the permission set groups in a project.
USAGE
$ sf p ls psg [--json]
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Lists all the permission set groups in a project.
When run inside a SFDX project, it finds all the permission set groups in each of the package directories specified in
the `sfdx-project.json` file.
ALIASES
$ sf permissions list permission-set-groups
$ sf permissions ls groups
$ sf permissions ls psg
$ sf p ls psg
EXAMPLES
$ sf p ls psg
sf p ls uap
Lists all the user access policies in a project.
USAGE
$ sf p ls uap [--json]
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Lists all the user access policies in a project.
When run inside a SFDX project, it finds all the user access policies in each of the package directories specified in
the `sfdx-project.json` file.
ALIASES
$ sf permissions list user-access-policies
$ sf permissions ls policies
$ sf permissions ls uap
$ sf p ls uap
EXAMPLES
$ sf p ls uap
sf permissions list groups
Lists all the permission set groups in a project.
USAGE
$ sf permissions list groups [--json]
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Lists all the permission set groups in a project.
When run inside a SFDX project, it finds all the permission set groups in each of the package directories specified in
the `sfdx-project.json` file.
ALIASES
$ sf permissions list permission-set-groups
$ sf permissions ls groups
$ sf permissions ls psg
$ sf p ls psg
EXAMPLES
$ sf permissions list groups
sf permissions list permission-set-groups
Lists all the permission set groups in a project.
USAGE
$ sf permissions list permission-set-groups [--json]
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Lists all the permission set groups in a project.
When run inside a SFDX project, it finds all the permission set groups in each of the package directories specified in
the `sfdx-project.json` file.
ALIASES
$ sf permissions list permission-set-groups
$ sf permissions ls groups
$ sf permissions ls psg
$ sf p ls psg
EXAMPLES
$ sf permissions list permission-set-groups
sf permissions list permission-sets
Lists all the permission sets in a project.
USAGE
$ sf permissions list permission-sets [--json]
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Lists all the permission sets in a project.
When run inside a SFDX project, it finds all the permission sets in each of the package directories specified in the
`sfdx-project.json` file.
ALIASES
$ sf permissions list permission-sets
$ sf permissions ls sets
$ sf permissions ls ps
$ sf p ls ps
EXAMPLES
$ sf permissions list permission-sets
sf permissions list policies
Lists all the user access policies in a project.
USAGE
$ sf permissions list policies [--json]
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Lists all the user access policies in a project.
When run inside a SFDX project, it finds all the user access policies in each of the package directories specified in
the `sfdx-project.json` file.
ALIASES
$ sf permissions list user-access-policies
$ sf permissions ls policies
$ sf permissions ls uap
$ sf p ls uap
EXAMPLES
$ sf permissions list policies
sf permissions list sets
Lists all the permission sets in a project.
USAGE
$ sf permissions list sets [--json]
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Lists all the permission sets in a project.
When run inside a SFDX project, it finds all the permission sets in each of the package directories specified in the
`sfdx-project.json` file.
ALIASES
$ sf permissions list permission-sets
$ sf permissions ls sets
$ sf permissions ls ps
$ sf p ls ps
EXAMPLES
$ sf permissions list sets
sf permissions list user-access-policies
Lists all the user access policies in a project.
USAGE
$ sf permissions list user-access-policies [--json]
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Lists all the user access policies in a project.
When run inside a SFDX project, it finds all the user access policies in each of the package directories specified in
the `sfdx-project.json` file.
ALIASES
$ sf permissions list user-access-policies
$ sf permissions ls policies
$ sf permissions ls uap
$ sf p ls uap
EXAMPLES
$ sf permissions list user-access-policies
sf permissions ls groups
Lists all the permission set groups in a project.
USAGE
$ sf permissions ls groups [--json]
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Lists all the permission set groups in a project.
When run inside a SFDX project, it finds all the permission set groups in each of the package directories specified in
the `sfdx-project.json` file.
ALIASES
$ sf permissions list permission-set-groups
$ sf permissions ls groups
$ sf permissions ls psg
$ sf p ls psg
EXAMPLES
$ sf permissions ls groups
sf permissions ls policies
Lists all the user access policies in a project.
USAGE
$ sf permissions ls policies [--json]
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Lists all the user access policies in a project.
When run inside a SFDX project, it finds all the user access policies in each of the package directories specified in
the `sfdx-project.json` file.
ALIASES
$ sf permissions list user-access-policies
$ sf permissions ls policies
$ sf permissions ls uap
$ sf p ls uap
EXAMPLES
$ sf permissions ls policies
sf permissions ls ps
Lists all the permission sets in a project.
USAGE
$ sf permissions ls ps [--json]
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Lists all the permission sets in a project.
When run inside a SFDX project, it finds all the permission sets in each of the package directories specified in the
`sfdx-project.json` file.
ALIASES
$ sf permissions list permission-sets
$ sf permissions ls sets
$ sf permissions ls ps
$ sf p ls ps
EXAMPLES
$ sf permissions ls ps
sf permissions ls psg
Lists all the permission set groups in a project.
USAGE
$ sf permissions ls psg [--json]
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Lists all the permission set groups in a project.
When run inside a SFDX project, it finds all the permission set groups in each of the package directories specified in
the `sfdx-project.json` file.
ALIASES
$ sf permissions list permission-set-groups
$ sf permissions ls groups
$ sf permissions ls psg
$ sf p ls psg
EXAMPLES
$ sf permissions ls psg
sf permissions ls sets
Lists all the permission sets in a project.
USAGE
$ sf permissions ls sets [--json]
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Lists all the permission sets in a project.
When run inside a SFDX project, it finds all the permission sets in each of the package directories specified in the
`sfdx-project.json` file.
ALIASES
$ sf permissions list permission-sets
$ sf permissions ls sets
$ sf permissions ls ps
$ sf p ls ps
EXAMPLES
$ sf permissions ls sets
sf permissions ls uap
Lists all the user access policies in a project.
USAGE
$ sf permissions ls uap [--json]
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Lists all the user access policies in a project.
When run inside a SFDX project, it finds all the user access policies in each of the package directories specified in
the `sfdx-project.json` file.
ALIASES
$ sf permissions list user-access-policies
$ sf permissions ls policies
$ sf permissions ls uap
$ sf p ls uap
EXAMPLES
$ sf permissions ls uap