Salesforce CLI

🚀 Salesforce 命令行界面（CLI）集成工具

本工具用于集成 Salesforce CLI，可帮助开发者高效地进行集成开发和管理，提供了丰富的命令和功能，满足不同场景的需求。

🚀 快速开始

在开始使用 Salesforce CLI 集成工具之前，请按照以下步骤进行安装和初始化。安装完成并初始化后，即可使用核心命令进行项目创建、配置和命令执行等操作。

📦 安装指南

1. 安装 Salesforce CLI

• macOS：运行 brew install salesforce/salesforce-cli。
• Windows：从 Salesforce CLI 下载页面下载并安装 MSI 包。
• Linux：使用以下命令：

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

2. 初始化工具

运行 sf init 命令以初始化 Salesforce CLI 环境并安装必要的依赖项。

💻 使用示例

基础用法

核心命令示例

• 项目创建：

  sf project create --name MyProject
  

• 项目配置：

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

• 命令执行：

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

常用工具

• 缓存刷新：sf_cache_refresh
• 项目管理：sf_project_manage
• 日志获取：sf_apex_log_get

高级用法

批处理命令

将命令保存到 script.sh 脚本文件中：

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

然后赋予脚本执行权限并运行：

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

日志与调试

通过 --verbose 标志启用详细日志记录：

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

📚 详细文档

深入集成

配置 Salesforce CLI 环境变量

在 .bashrc 或 .zshrc 文件中添加以下内容：

export SF_API_VERSION=58.0

插件管理

使用 sf plugins 命令查看已安装的插件，或通过 sf plugin install PLUGIN_NAME 安装新的插件。

参数配置

快速配置示例

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

环境变量设置

创建 config.json 文件：

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

⚠️ 安全注意事项

• 凭据保护：避免在命令行中直接输入敏感信息，建议使用配置文件或环境变量。
• 权限管理：定期检查并更新访问令牌和 API 密钥，确保安全。
• 网络监控：在受控的网络环境中执行 CLI 操作，防止未授权访问。

❓ 常见问题

1. 如何处理命令缓存过期？

运行 sf_cache_refresh 刷新缓存或手动删除 ~/.sf-mcp/command-cache.json 文件后重新启动服务。

2. 插件安装失败怎么办？

检查网络连接，确保 Salesforce 服务器可访问，并尝试使用代理设置：

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

3. 配置文件丢失如何恢复？

重新运行 sf init 命令以重建默认配置文件。

📄 文档与资源

• 官方文档：Salesforce CLI 文档
• 开发者论坛：Salesforce 开发者社区
• 支持中心：Salesforce 支持

通过以上步骤和指南，您可以高效地使用 Salesforce CLI 进行集成开发和管理。