Skip to content

Home

Jump to bottom
Peter Chittum edited this page Nov 2, 2018 · 3 revisions

Welcome to the Salesforce Command Line cookbook wiki!

The Salesforce Command Line Interface (CLI) is an exciting addition to the Salesforce developer and administrator toolkit.

While many recognize this immediately, others can be put off by the complexity of using a command line tool. Still others may not be accustomed to using command line tools at all, and can be put off by the learning curve of adjusting to a text-based user interface.

To help bring more of these users to the Salesforce CLI, this cookbook was conceived of as a recipe book and a supplement to the Salesforce CLI Command Reference documentation to provide greater context to specific CLI actions.

Where the command reference is the definitive reference as to how each Salesforce CLI command works, we intend for this cookbook to be the why and the how to help developers and admins alike solve specific problems and learn to make use of the CLI around day-to-day tasks.

This cookbook is organized and modeled on the Examples of Advanced Formula Fields, the Examples of Validation Rules, and similar Salesforce documentation. Each "recipe" should identify a specific business problem, and provide one or more ways to solve that problem using the salesforce CLI.

We may also provide supplemental guidance and documentation to help with getting started with the Salesforce CLI, such as installation, adding plugins, and other tasks. The documentation for Salesforce DX is excellent, so we want to limit these topics specifically to where we feel we can add context for users who are less experienced with command lines.

The OS Problem

The Salesforce CLI is supported in every major operating system, however some recipes may make use of features that are specific to a given operating system or shell (bash, PowerShell, cmd, zsh, etc.). Where applicable, each recipe should provide alternate instructions for at least bash, and one of the Windows-based shells.

Index of Problem Areas

Below are a list of problem areas for which we have existing recipes:

  • Data Management
  • Debug Logs
  • Reporting Org Limits
  • Sandbox Management
  • Scheduling Commands in Linux
  • Scheduling Commands in Mac OS bash
  • Scheduling Commands in Windows
  • User Management
Clone this wiki locally