afv-library/skills/dx-org-manage/references/opening-org.md

Opening Orgs

Opens a Salesforce org or specific metadata artifact in a browser using sf org open. Handles all variants: default org, alias or username, browser selection, incognito mode, path navigation, metadata file → Builder, and URL-only output.

---

Required Inputs

Infer from the user's request:

• Target org: Use default org unless a specific alias/username is mentioned
• What to open: Path, file, or org home
• Browser: Only include if explicitly requested (chrome, firefox, edge)
• Incognito: Only if user says "private" or "incognito"
• URL only: If user says "URL", "link", or "don't open browser"

Do not ask for clarification - infer and execute immediately.

---

Workflow

1. Match user request to command in table below
2. Execute via Bash tool: sf org open with appropriate flags
3. Return result

If error occurs:

• "no target org" → advise: sf config set target-org <alias>
• auth error → advise: sf org login web --alias <alias>

Command Decision Table

User intent	Execute via Bash tool
Open default org	sf org open
Open specific org	sf org open --target-org <alias>
Open in specific browser	sf org open --browser chrome (or firefox, edge)
Private/incognito mode	sf org open --private
Navigate to path	sf org open --path '<path>'
Get URL only	sf org open --url-only
Path + URL only	sf org open --path '<path>' --url-only
Open local file	sf org open --source-file <file-path>
File + URL only	sf org open --source-file <file-path> --url-only

Note: Flags --private, --url-only, --browser are mutually exclusive.

---

Common Paths

Setup Pages

# Setup home
sf org open --path '/lightning/setup/SetupOneHome/home'

# Object Manager
sf org open --path '/lightning/setup/ObjectManager/home'

# Users
sf org open --path '/lightning/setup/ManageUsers/home'

# Permission Sets
sf org open --path '/lightning/setup/PermSets/home'

# Flows
sf org open --path '/lightning/setup/Flows/home'

# Custom Metadata Types
sf org open --path '/lightning/setup/CustomMetadata/home'

App Pages

# App Launcher
sf org open --path '/lightning/setup/NavigationMenus/home'

# Reports
sf org open --path '/lightning/o/Report/home'

# Dashboards
sf org open --path '/lightning/o/Dashboard/home'

---

Opening Metadata Files

Supported Metadata Types

--source-file works with these metadata types:

• FlexiPage (Lightning pages) → Lightning App Builder
• Flow → Flow Builder
• ApexPage (Visualforce) → Visualforce Page Editor
• ApexClass → Apex Class detail page
• CustomObject → Object Manager

Important Constraints

Constraint	Behavior
Metadata must be deployed in the org	CLI queries org for record ID; undeployed metadata causes error or fallback
FlexiPage fallback	Silently falls back to /lightning/setup/FlexiPageList/home if not found
Flow error	Throws FlowIdNotFound if Flow not deployed
ApexClass error	Throws ApexClassIdNotFound if class not deployed
CustomObject error	Throws CustomObjectIdNotFound if object not deployed

Example Commands

# Open Lightning page in App Builder
sf org open --source-file force-app/main/default/flexipages/Account_Record_Page.flexipage-meta.xml

# Open Flow in Flow Builder
sf org open --source-file force-app/main/default/flows/MyFlow.flow-meta.xml

# Open Apex class
sf org open --source-file force-app/main/default/classes/MyController.cls

---

Rules / Constraints

Constraint	Rationale
--path and --source-file are mutually exclusive	Both control navigation destination; choose one
--source-file supported types: FlexiPage, Flow, ApexPage, ApexClass, CustomObject	CLI queries the org for the record ID; unsupported types or undeployed metadata fall back silently (FlexiPage) or throw a named error (Flow/ApexClass/CustomObject)
Do not hardcode force-app/main/default/ for --source-file	Project package paths vary; use the path the user provides or read sfdx-project.json
Must use Bash tool, not MCP tools	MCP tools like list_all_orgs cannot open orgs in browser

---

Troubleshooting

Issue	Resolution
No target org found	Set default: sf config set target-org <alias> or specify --target-org <alias>
Auth error	Re-authenticate: sf org login web --alias <alias>
--source-file opens wrong page or throws FlowIdNotFound / ApexClassIdNotFound / CustomObjectIdNotFound	Metadata is not deployed in the org. Run sf project deploy start --source-file <path> --target-org <alias> first. FlexiPage silently falls back to org home; Flow/ApexClass/CustomObject throw an error.
Metadata file opens wrong Builder	Verify the file extension matches the metadata type (e.g. .flow-meta.xml for Flow Builder)
URL-only flag but user expects browser to open	--url-only prints the URL without launching — remove the flag to open the browser
Path not found / 404	Verify the path is correct; some paths require specific permissions or licenses

---

Output Expectations

Default behavior

• Opens the specified org/path in the system's default browser
• No console output on success

With --url-only

Returns the login URL without opening browser:

https://...-dev-ed.develop.my.salesforce.com/secur/frontdoor.jsp?sid=...

With --source-file

• Opens the metadata in its appropriate Builder/Editor
• Example: FlexiPage → Lightning App Builder, Flow → Flow Builder