skills.rest
Mar5929
Mar5929COMMUNITY
Explore all skills by this author →
WebsiteGitHub

sf-org-knowledge

Generate a persistent Markdown knowledge base from read-only Salesforce org metadata.

Updated Aug 23, 2026
Search Tags:#documentation#metadata#salesforce#read-only#sf-cli#org-atlas
One-click install
npx skills add https://github.com/Mar5929/.claude --skill sf-org-knowledge
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: sf-org-knowledge
Source: https://github.com/Mar5929/.claude/tree/main/skills/sf-org-knowledge
Command: npx skills add https://github.com/Mar5929/.claude --skill sf-org-knowledge

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires jq, salesforce-cli, and includes scripts (resource) components.

What problem does it solve?

Analyze a connected Salesforce org with read-only SF CLI commands to generate a persistent Markdown knowledge base in docs/org/ that new AI sessions can load for fast orientation.

Core Features & Use Cases

  • Generates a robust org atlas including ORG_INDEX.md, reference docs, a data-model.mermaid, and domain docs from read-only metadata.
  • Ensures safety by operating strictly in read-only mode, emitting local artifacts in docs/org/ and avoiding any org mutations.
  • Rerunnable and idempotent; overwrites _raw and reference docs on refresh to reflect the latest state.

Quick Start

Provide the target org alias and run this skill to generate the docs/org atlas.

Frequently Asked Questions about sf-org-knowledge

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

FAQPage Schema
How do I generate a Salesforce org atlas for AI session orientation?▼

Use this Skill to run read-only SF CLI commands against a connected Salesforce org and generate a persistent Markdown knowledge base in docs/org/. It produces an index, reference docs, and a data model to orient new AI sessions rapidly.

Can I extract Salesforce org metadata without modifying the production org?▼

Yes, you can extract Salesforce org metadata safely because this Skill operates strictly in read-only mode. It restricts operations to query commands and writes all generated atlas artifacts locally to avoid any org mutations.

What do I need to set up before generating a Salesforce org knowledge base?▼

You need the salesforce-cli and jq installed, plus a connected Salesforce org alias. Provide the target org alias when running the Skill to start generating the local Markdown documentation.

How does the Salesforce org atlas handle metadata changes after a refresh?▼

The org atlas is rerunnable and idempotent, overwriting raw metadata and reference docs on refresh. This ensures the generated Markdown knowledge base in docs/org/ always reflects the latest Salesforce org state.

Does this Skill generate visual data models for Salesforce objects?▼

Yes, the Skill generates a data-model.mermaid file from read-only Salesforce metadata. This visual diagram maps object relationships and is stored alongside reference docs in the docs/org/ directory.

What is the best way to document Salesforce org risks and domain opportunities?▼

Generate a persistent Markdown knowledge base using read-only SF CLI commands to analyze objects and metadata. The resulting atlas summarizes risks and domain opportunities, enabling fast orientation without manual inspection.

Related Skills

Explore More Data & Analytics Skills→
CollabalistCollabalist

deploying-ui-bundle

Automate Salesforce UI Bundle deployment with authentication, metadata, and permissions.

Community
Advanced
assofohdzassofohdz
25

zoom-out

Map modules and callers with domain-aligned explanations for unfamiliar code sections.

Community
Basic
kendreadityakendreaditya

youtube

Extract YouTube video metadata and subtitles using yt-dlp and jq.

Community
Intermediate
PranavNagrechaPranavNagrecha
2

refreshing-the-org-vault

Refresh the local SfIntelligence vault with Salesforce CLI metadata.

Community
Intermediate