Skip to content

Salesforce CLI Plugin for Navigating to the Salesforce UI

Notifications You must be signed in to change notification settings

PreziosiRaffaele/sf-meta-open

Repository files navigation

sf-meta-open

NPM Downloads/week License

A Salesforce CLI plugin that allows you to quickly open metadata files in the browser. This plugin provides a convenient way to navigate from your local metadata files directly to their corresponding web interface in Salesforce, improving developer productivity.

Install

sf plugins install sf-meta-open@latest

Usage

sf meta open --metadata <path-to-metadata-file> --targetusername <your-org>

Or use the alias for brevity:

sf meta open -f <path-to-metadata-file> -o <your-org>

About

This plugin analyzes a local Salesforce metadata file and opens its corresponding record directly in the browser. It automatically:

  1. Determines the metadata type based on the file extension
  2. Constructs the correct URL for viewing that specific metadata
  3. Opens your default browser to that URL

Commands

sf meta open

Open Salesforce metadata in your browser.

USAGE
  $ sf meta open -f <filepath> -o <orgname>

FLAGS
  -f, --metadata=<path>       (required) Path to the metadata file you want to open in Salesforce
  -o, --targetusername=<org>  (required) Username or alias of the target Salesforce org

DESCRIPTION
  Open Salesforce metadata in your browser.

  This command takes a local metadata file path and opens its corresponding record in the Salesforce web interface using your default browser.

EXAMPLES
  Open an Apex class:
    $ sf meta open --metadata force-app/main/default/classes/MyClass.cls --targetusername my-org

  Open a custom object:
    $ sf meta open -f force-app/main/default/objects/MyObject__c/MyObject__c.object-meta.xml -o my-org

About

Salesforce CLI Plugin for Navigating to the Salesforce UI

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published