@copado/copado-cli

Copado Developer CLI

Usage no npm install needed!

<script type="module">
  import copadoCopadoCli from 'https://cdn.skypack.dev/@copado/copado-cli';
</script>

README

pipeline status coverage report

Copado CLI

The Copado CLI is a Salesforce CLI plugin. This tool allows you to execute Copado-related tasks from an IDE/Terminal and leverage Git and Salesforce commands, Agile or issue tracking tools, such as Jira, and user story automation, among other things.

Let’s see how you can configure the CLI and start working with it.

Requirements and Set Up

Requirements

In order to start using the Copado CLI, you need the following elements:

  • Salesforce User and Managed Package licenses.
  • Copado Winter '20 (v15).
  • Copado org credential.
  • Copado license.
  • Branch management pipeline.
  • Salesforce CLI.
  • Git

Installation

  1. First of all, you need to download and install Salesforce CLI, as Copado CLI is a Salesforce CLI plugin.

  2. Insert the following command to install the Copado plugin:

     sfdx plugins:install @copado/copado-cli

    During the installation process, both plugin and dependencies will be installed.

  3. Link your Salesforce CLI with your Copado CLI using this command:

     sfdx copado:auth:set -u [user@mycompany.com]

    Where the username is the org credential you have already authenticated in Copado. You can use this command to authenticate the org where you have Copado installed.

     sfdx force:auth:web:login

  4. You can authenticate multiple orgs to work with the CLI and then use the command

     sfdx force:org:list

    In order to get the list of orgs that have been authenticated and their corresponding org Id.

Now that you know what the Copado CLI is and how you can set it up, take a look at our CLI Commands article to learn more about the actions you can perform with the CLI.