NOTE: This template for sf plugins is not yet official. Please consult with the Platform CLI team before using this template.

Salesforce Orchestrator Plugin


A Salesforce CLI plugin for working with orchestrated apps, templates, assets, and services.

Installation

If you want to contribute to the plugin or run it from source:

``bash


Clone the repository

git clone https://github.com/salesforcecli/plugin-orchestrator.git
cd plugin-orchestrator

Install dependencies

yarn install

Build the plugin

yarn build

Link to your local SF CLI

sf plugins link .
`

Running Locally for Development

When developing the plugin, you can run it in several ways:

$3

After linking the plugin with sf plugins link ., you can run commands normally:

`bash
sf orchestrator template list --help
`

$3

`bash


Run a command using the local development script


./bin/dev.js orchestrator template list --help
`

$3

`bash


Run all tests

yarn test

Run unit tests only

yarn test:only

Run NUTs (Node Unit Tests)

yarn test:nuts
`

Commands

The plugin provides commands for working with templates and apps.

$3

`bash


List templates in an org

sf orchestrator template list -o

Display details of a specific template

sf orchestrator template display -o --template-id

Create a new template

sf orchestrator template create -o --name [--label ] [--type ]

Update an existing template

sf orchestrator template update -o --template-id [--label ] [--description ]

Delete a template

sf orchestrator template delete -o --template-id
`

$3

`bash


List apps in an org

sf orchestrator app list -o

Display details of a specific app

sf orchestrator app display -o --app-id

Create a new app

sf orchestrator app create -o --name [--label ] [--template-id ]

Update an existing app

sf orchestrator app update -o --app-id [--label ] [--description ]

Delete an app

sf orchestrator app delete -o --app-id
`

Issues

Please report any issues at https://github.com/salesforcecli/plugin-orchestrator/issues

Contributing

1. Please read our Code of Conduct
2. 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.
3. Fork this repository.
4. Build the plugin locally
5. Create a _topic_ branch in your fork. Note, this step is recommended but technically not required if contributing using a fork.
6. Edit the code in your fork.
7. 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.
8. Sign CLA (see CLA below).
9. Send us a pull request when you are done. We'll review your code, suggest any needed changes, and merge it in.

$3

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.

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 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.

$3

- @salesforce/core
- @salesforce/kit
- @salesforce/sf-plugins-core
- @salesforce/ts-types
- @salesforce/ts-sinon
- @salesforce/dev-config
- @salesforce/dev-scripts

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.