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 進行集成開發和管理。