move-qcp/README.md

Deploy CPQ Quote Calculator Plugin

# move-qcp

The [Javascript Quote Calculator Plugin](https://developer.salesforce.com/docs/atlas.en-us.cpq_dev_plugins.meta/cpq_dev_plugins/cpq_dev_jsqcp_parent.htm) is useful to add extra functionality to the quote line editor in Salesforce CPQ.

Unfortunately the code is stored as data within Salesforce, making it difficult to manage and track changes effectively.

With this plugin, you can now create a dedicated QCP folder within your repository and effortlessly deploy it to the target org.

This brings several benefits:

1. **Versioning QCP Code:** Your code is securely stored, easily accessible, and conveniently managed alongside your other version-controlled assets. This ensures that you have complete control over your qcp code and can effectively track and review changes.
2. **Automated Deployment:** The plugin automatically deploys the QCP to the target org, avoiding the need to manually copy and paste the code into Salesforce.
3. **Modularization:** Take advantage of modularization by utilizing modules to split the QCP code into multiple files.
4. **Code Minification:** The plugin automatically minifies the code before deploying it to the target org. This optimization step helps avoid reaching the maximum character limit of the textarea field.

## Install

```bash
sf plugins install move-qcp
```

## Commands

<!-- commands -->

- [`sf cpq qcp create`](#sf-cpq-qcp-create)
- [`sf cpq qcp deploy`](#sf-cpq-qcp-deploy)

## `sf cpq qcp create`

Create the QCP folder structure.

```
USAGE
  $ sf cpq qcp create

FLAGS
  -n, --name=<value> [required] The desired name for the custom script along with the folder name for its creation.
  -d, --outputdir=<value> Directory path to store the QCP [default: current directory].

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Create the QCP folder structure.

EXAMPLES
  sf cpq qcp create -n MyQCP
```

## `sf cpq qcp deploy`

Deploy the QCP to the target org.

```
USAGE
  $ sf cpq qcp deploy

FLAGS
  -u, --targetusername=<value>  [required] A username or alias for the target org.
  -d, --sourcedir=<value> [required] The directory path to the QCP.
  -c, --no-code-minification  Deploy without code minification. [default: false]

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Deploy the QCP to the target org.

EXAMPLES
  sf cpq qcp deploy -u orgAlias -d ./qcp
```