Copado CLI

Deprecated: @copado/copado-cli is no longer the supported Copado command-line experience. Install Agentia CLI instead:

npm install -g @copado/agentia-cli@beta

Documentation: https://developer.copado.com/docs

The Copado CLI is a legacy Salesforce CLI plugin. It remains installable for existing workflows, but new development should use Agentia CLI.

The sections below describe legacy plugin installation and contributor setup for this repository.

Requirements and Set Up

Requirements

• Contributors: Node.js 20 LTS when running npm test / npm run build locally (matches .gitlab-ci.yml and avoids loader issues on newer Node versions).

Contributors — sf plugins link (local checkout)

If you link this repository into the global Salesforce CLI (sf plugins link . from the repo root), generate the command manifest after every successful compile, before (or right after) linking:

npm install
npm run plugins:link-prep
sf plugins unlink @copado/copado-cli 2>/dev/null || true
sf plugins link .

oclif.manifest.json is gitignored; it is produced by oclif manifest and tells the CLI to load lib/commands/**/*.js. If you skip this step, sf may try to JIT-compile TypeScript for the linked plugin and print many TSError: Unable to compile TypeScript warnings (often with an empty detail line), then copado … is not a sf command. After git pull, run npm run plugins:link-prep again, then re-link.

First run (sf CLI)

1. Authenticate a Salesforce org and set a default (sf org login web / sf config set target-org …).
2. Link that org to Copado CLI: sf copado auth set -u <username> (or pass the username as a positional argument).
3. Optional: run sf copado setup to pick a role and create a starter .copado/queries.json (Developer preset).
4. Prefer canonical topics: sf copado story … (user stories), sf copado auth get, sf copado job get, sf copado env list, sf copado repo list. Legacy work, auth display, job status, environment list, and repository list still work but print a one-line deprecation on stderr (suppressed with --json).

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

Legacy plugin installation (deprecated)

Prefer Agentia CLI (npm install -g @copado/agentia-cli@beta) and Copado developer documentation.

If you still need this Salesforce CLI plugin:

1. Install Salesforce CLI.
2. Install the plugin: sf plugins install @copado/copado-cli
3. Link your org: sf copado auth set -u [email protected]

Legacy command reference: CLI Commands.

VS Code extension (experimental)

A sibling package under vscode-extension/ wraps sf copado … for the editor (argv-only subprocess, no Copado Apex REST from the extension). It adds Quick actions (QuickPick over the registry), an activity bar view, Git SCM title shortcuts, a status bar entry, output redaction, and a six-step Getting Started walkthrough (copado.firstRun). See vscode-extension/README.md for trust/cwd behavior, troubleshooting, F5, and copado.salesforceCliPath.