Salesforce CLI

🚀 Salesforce Command Line Interface (CLI) Integration Tool

This tool integrates Salesforce CLI, streamlining development and management tasks. It simplifies operations such as project creation, configuration, and command execution, enhancing efficiency.

🚀 Quick Start

Core Command Examples

• Create a Project:

sf project create --name MyProject

• Configure a Project:

sf config:set -n MyProject --username yourUsername@example.com

• Execute a Command:

sf apy:log:get --organization-id my-org-id

Commonly Used Tools

• Refresh Cache: sf_cache_refresh
• Manage Projects: sf_project_manage
• Retrieve Logs: sf_apex_log_get

📦 Installation

Before using the Salesforce CLI Integration Tool, follow these steps to install and initialize it:

1. Install Salesforce CLI

• macOS: Run brew install salesforce/salesforce-cli.
• Windows: Download and install the MSI package from the Salesforce CLI Download Page.
• Linux: Use the following command:

curl -o /usr/local/bin/sf https://cli-assets.s3.amazonaws.com/latest/cli.js && chmod +x /usr/local/bin/sf

2. Initialize the Tool

Run the sf init command to initialize the Salesforce CLI environment and install the necessary dependencies.

💻 Usage Examples

Basic Usage

# Create a project
sf project create --name MyProject

Advanced Usage

# Configure a project with multiple parameters
sf config:set -n MyProject \
  --username yourUsername@example.com \
  --password yourPassword \
  --organization-id my-org-id

📚 Documentation

In - Depth Integration

Configure Salesforce CLI Environment Variables

Add the following to your .bashrc or .zshrc file:

export SF_API_VERSION=58.0

Plugin Management

Use the sf plugins command to view installed plugins, or install new ones with sf plugin install PLUGIN_NAME.

Parameter Configuration

Quick Configuration Example

sf config:set -n MyProject \
  --username yourUsername@example.com \
  --password yourPassword \
  --organization-id my-org-id

Environment Variable Settings

Create a config.json file:

{
  "default": {
    "instanceUrl": "https://my-domain.my.salesforce.com",
    "accessToken": "your-access-token"
  }
}

Advanced Features

Batch Commands

Save commands in a script.sh file:

#!/bin/bash
sf apy:log:get --organization-id my-org-id > logs.txt
sf report:generate --type daily > report.pdf

Then give the script execution permission and run it:

chmod +x script.sh && ./script.sh

Logging and Debugging

Enable verbose logging with the --verbose flag:

sf apy:log:get --organization-id my-org-id --verbose

🔒 Security Precautions

• Credential Protection: Avoid entering sensitive information directly in the command line. Use configuration files or environment variables instead.
• Permission Management: Regularly check and update access tokens and API keys to ensure security.
• Network Monitoring: Execute CLI operations in a controlled network environment to prevent unauthorized access.

❓ Frequently Asked Questions

1. How to handle expired command cache?

Run sf_cache_refresh to refresh the cache or manually delete the ~/.sf - mcp/command - cache.json file and restart the service.

2. What if plugin installation fails?

Check your network connection, ensure the Salesforce server is accessible, and try using proxy settings:

sf plugin install PLUGIN_NAME --proxy http://proxy.example.com:8080

3. How to recover a lost configuration file?

Re - run the sf init command to rebuild the default configuration file.

📄 Resources

• Official Documentation: Salesforce CLI Documentation
• Developer Forum: Salesforce Developer Community
• Support Center: Salesforce Support

By following the above steps and guidelines, you can efficiently use the Salesforce CLI for integration development and management.