platform-metadata-retrieve

Retrieve Salesforce org metadata into a local project using sf project retrieve start.

Updated Jun 17, 2026
One-click install
npx skills add https://github.com/angryracoon/ARIEF-VISEO-DEV-ORG --skill platform-metadata-retrieve
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: platform-metadata-retrieve
Source: https://github.com/angryracoon/ARIEF-VISEO-DEV-ORG/tree/main/.agents/skills/platform-metadata-retrieve
Command: npx skills add https://github.com/angryracoon/ARIEF-VISEO-DEV-ORG --skill platform-metadata-retrieve

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill removes the manual friction of bringing Salesforce metadata from an org into a local project, helping you sync changes quickly and reliably.

Core Features & Use Cases

  • Multiple Retrieval Modes: Retrieve all remote changes, a source directory, specific metadata types, a manifest, or a package name.
  • Flexible Output Handling: Support source format by default or metadata format with ZIP extraction when needed.
  • Guardrails and Troubleshooting: Handles conflicts, org compatibility, output directory rules, wildcard quoting, and other common command pitfalls.
  • Use Case: A developer needs to pull a changed Apex class and related object metadata from a sandbox without overwriting local work; this Skill selects the right retrieve mode and flags to complete the sync safely.

Quick Start

Ask the assistant to retrieve the required Salesforce metadata from your org into the local project using the platform-metadata-retrieve skill.

Frequently Asked Questions about platform-metadata-retrieve

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I retrieve Salesforce metadata from a sandbox into a local project?

To retrieve Salesforce metadata from a sandbox, use the sf project retrieve start command with the appropriate target org and wait time flags. This syncs remote changes into your local project directory using source or metadata format.

Can I pull specific Apex classes and object metadata using a package.xml manifest?

Yes, you can pull specific Apex classes and objects using a package.xml manifest. The retrieve command supports manifest-based retrieval to selectively sync only the metadata types defined in your package file.

What's the best way to retrieve all remote Salesforce org changes without overwriting local work?

The best way to retrieve all remote changes safely is by using the full-change retrieval mode. This syncs org updates into your local project while applying guardrails to handle conflicts and prevent overwriting local work.

Does the sf cli retrieve command support source format and ZIP extraction for metadata format?

Yes, the sf cli retrieve command supports source format by default and metadata format with ZIP extraction. This flexible output handling ensures metadata is correctly formatted for your local project structure.

Why does my Salesforce metadata retrieve command fail when using wildcards in package.xml?

Your Salesforce metadata retrieve command may fail due to incorrect wildcard quoting in package.xml. Following proper output directory rules and wildcard syntax ensures the sf cli parses the manifest correctly.

What scenarios are supported for scratch org, sandbox, and production org metadata retrieval?

Supported scenarios for scratch org, sandbox, and production org metadata retrieval include source-directory, metadata-type, manifest, package-name, and full-change retrieval modes using the sf project retrieve start command.