forcedotcom/sf-skills

dx-org-shape-manage

ALWAYS USE THIS SKILL to create, list, or delete org shapes.

Ver código fuente

Cómo usar

  1. Copia el comando y revisa el paquete antes de instalarlo en tu entorno de agente.
  2. Consulta las herramientas, credenciales y entornos necesarios en el documento original.
  3. Describe las entradas y el resultado deseado; contrasta la salida con las fuentes.
npx skills add https://github.com/forcedotcom/sf-skills --skill dx-org-shape-manage

Antes de empezar

  • La instalación no incluye suscripción al modelo, cuota API ni permisos sobre tus archivos.
  • Las estrellas e instalaciones reflejan actividad, no una prueba independiente de calidad o seguridad.
Documento original del Skill

Contenido del repositorio de origen con títulos, ejemplos, código, tablas, enlaces e imágenes preservados.

dx-org-shape-manage

Coordinates the full lifecycle of Salesforce org shapes — create, list, and delete — via sf org create shape, sf org list shape, and sf org delete shape. An org shape captures the baseline setup of a source org (features, limits, edition, and Metadata API settings) without its data or metadata.


Tool Restrictions

Use ONLY the Bash tool to execute the sf org ... shape commands. Do NOT use MCP tools — ignore them completely.

Output artifacts for eval/testing: ALWAYS write the command's complete JSON response to a file when an output directory is available. Do NOT ask the user what file to write — this skill defines the filenames. After executing each command: (1) if the user specified an output path (e.g. "write all generated files into folder X"), write there immediately; (2) otherwise run [ -d force-app/main/adk-eval-output/ ] && echo 'force-app/main/adk-eval-output' to detect the eval directory; (3) write the command's full, unmodified JSON response (including the status/result/warnings wrapper) to <output-dir>/<filename> using these filenames: create-shape-result.json for shape creation, list-shapes-result.json for listing shapes, list-shapes-inactive-result.json for the inactive-shapes SOQL query, or delete-shapes-result.json for shape deletion. This is the generated output — write it without asking. Do NOT say "no files to generate" for these operations; the JSON result IS the output artifact.


Scope

  • In scope: Creating (sf org create shape), listing (sf org list shape), listing including inactive shapes for a specific source org (SOQL against ShapeRepresentation), and deleting (sf org delete shape) org shapes
  • Out of scope: Creating snapshots, creating scratch orgs (use dx-org-manage)

Required Inputs

Infer from the user's request:

  • Operation: create, list, list-including-inactive, or delete (see Workflow step 1)
  • Source org (create, delete, & list-including-inactive): Username or alias of the org to shape / whose shapes to delete or query. Passed via --target-org. Plain listing (Active/InProgress only) needs no source org.

Notes:

  • There is no --name or --description flag — a shape is identified by the source org's ID, not a custom name.
  • There is no --target-dev-hub flag — the shape commands operate on the source org directly, not a Dev Hub.

Workflow

  1. Identify the operation and match it to the command pattern below.
  2. For create/delete, confirm the source org — identify the username/alias. If not provided, check the default with sf config get target-org.
  3. Execute via Bash tool with the --json flag.
  4. Report the result (see Output Expectations and the example files).

Command Patterns

OperationUser intentExecute via Bash tool
CreateCreate shape from an orgsf org create shape --target-org <alias> --json
CreateCreate shape from the default target orgsf org create shape --json
ListList all org shapes + IDs/status (Active/InProgress only)sf org list shape --json
ListSave the list to a filesf org list shape --json > tmp/MyOrgShapeList.json
List (including inactive)List all shapes — including Inactive ones — for a specific source orgsf data query --target-org <alias> --query "SELECT Id, Name, Status, CreatedDate, LastModifiedDate FROM ShapeRepresentation" --json
DeleteDelete shapes for an org (with confirm prompt)sf org delete shape --target-org <alias> --json
DeleteDelete shapes without prompting (scripts/CI)sf org delete shape --target-org <alias> --no-prompt --json

After creating a shape, run sf org list shape --json to get its org ID.

Listing Inactive Shapes

sf org list shape has no flag to surface Inactive shapes and no `--target-org` flag (it always scans every locally authenticated org). To see a source org's full shape history — including shapes superseded by a later sf org create shape run — query ShapeRepresentation directly:

bash
sf data query --target-org <alias> --query "SELECT Id, Name, Status, CreatedDate, LastModifiedDate FROM ShapeRepresentation" --json

Only use this query when the user explicitly asks for inactive or all/historical shapes for a named source org. For ordinary "list my org shapes" requests, keep using sf org list shape — it is the documented, cross-org command and matches the rest of this skill's behavior.

Notes:

  • ShapeRepresentation has no SourceOrgId, username, or alias field — report the raw query fields (Id, Name, Status, CreatedDate, LastModifiedDate) as returned; do not invent an orgId/username/alias for these rows.
  • Add WHERE Status = 'Inactive' to scope to only inactive shapes if the user asks for inactive shapes specifically (as opposed to "all"/"history").
  • Requires the same ShapeRepresentation CRUD access as create/delete.

Rules / Constraints

ConstraintRationale
Always use --json flagProvides structured output for reliable parsing and error handling
Source org must have Org Shape for Scratch Orgs enabledWithout it, create/delete fail with a no-access error — enable via Setup → Scratch Orgs → Enable Org Shape for Scratch Orgs in the source org
User needs access to the ShapeRepresentation objectWithout CRUD access, create fails with NoCrudAccessCreateShape — ask the org admin
--target-org is the SOURCE org, not a Dev HubCreate/delete operate on this org; it is not a Dev Hub operation. List takes no --target-org
No --name / --description flagsA shape is keyed off the source org's ID, not a custom name
One active shape per source orgRe-running create replaces the prior shape (marks it inactive). delete removes all shapes for the org
delete prompts for confirmation by defaultUse --no-prompt (-p) for non-interactive/CI use; declining the prompt aborts with no deletion

Troubleshooting

IssueResolution
ShapeRepresentationNoAccess — "The org needs to be enabled for org shape before one can be created"Source org isn't enabled for org shape — in the source org go to Setup → Scratch Orgs → Enable Org Shape for Scratch Orgs, turn it on, then retry
NoCrudAccessCreateShape — "Can't create org shape. Contact the org admin..."You lack access to the ShapeRepresentation object — ask the org admin to grant access, then retry
ShapeCreateFailed — "Error creating scratch definition file..."Generic create failure — verify the source org is reachable/authenticated and retry; if it persists, contact Salesforce support
UNKNOWN_EXCEPTION on create (generic error with a support ErrorId, reproducible on retry)The source org is not fully enabled for org shape even though ShapeRepresentation may be partially visible — confirm Setup → Scratch Orgs → Enable Org Shape for Scratch Orgs is on in the source org and that your user has CRUD on ShapeRepresentation, then retry
sf org list shape returns an empty listNo shapes exist yet (or none are Active/InProgress) — create one with sf org create shape
sf org list shape doesn't show a shape the user expectsIt only surfaces Active/InProgress shapes and has no flag to change this — a prior sf org create shape run may have marked it Inactive. Use the SOQL query in "Listing Inactive Shapes" against that specific source org instead
Delete exits with code 68 (partial failure)Some shapes failed to delete — inspect the failures array in the JSON for per-shape messages, then retry
Delete exits with code 1 (all failed)Deletion failed entirely — confirm the org is enabled for org shape and you have access
No org found for <alias> / NamedOrgNotFoundErrorSource org alias doesn't exist or isn't authenticated — verify with sf org list or re-auth with sf org login web
No default target org and --target-org omittedProvide --target-org <alias> or set a default with sf config set target-org=<alias>

Output Expectations

All commands return JSON when --json is used:

  • Create → shapeId, success, and errors.
  • List → an array of shapes, each with orgId, username, alias, shapeId, status (Active or InProgress), createdBy, and createdDate.
  • List (including inactive) → a SOQL query result (records, totalSize, done), each record with Id, Name, Status (Active, InProgress, or Inactive), CreatedDate, and LastModifiedDate — no orgId/username/alias, since ShapeRepresentation has no such fields.
  • Delete → orgId, shapeIds (deleted), and failures. Returns no result if the user declines the confirmation prompt.

See the example files referenced below for full response structures.


Cross-Skill Integration

NeedDelegate to
Create a scratch org, or create/use a snapshotdx-org-manage skill

Reference File Index

FileWhen to read
examples/create_success_output.jsonTo understand the successful shape-creation response structure
examples/create_error_output.jsonTo handle common create error scenarios
examples/list_output.jsonTo understand the list response structure (org IDs, status)
examples/list_inactive_output.jsonTo understand the SOQL query response structure for listing shapes including Inactive ones
examples/delete_output.jsonTo understand the delete response structure (deleted IDs, failures)
references/cli_flags.mdFor detailed explanation of all flags across create/list/delete

Relacionados por tarea

del mismo repositorio

Más Skills

Todos los Skills
forcedotcom
Comunidad

design-systems-slds-apply

Apply SLDS-compliant UI using the correct blueprints, styling hooks, utility classes, and icons. Use when building any UI that needs SLDS, choosing between Lightning Base Components and SLDS Blueprints, applying styling hooks for theming, using utility classes for layout and spacing, or selecting icons. Triggers include \"build a modal\", \"create a form\", \"data table\", \"SLDS styling\", \"style with hooks\", \"add an icon\".

Instalaciones / 1h
1
GitHub Stars
1,2 mil
Actualizado
13 nov
forcedotcom
Comunidad

dx-code-analyzer-run

Run Salesforce Code Analyzer to scan code for security, performance, best practice, and code style violations. Supports all engines (PMD, ESLint, CPD, RetireJS, Flow, SFGE, ApexGuru), targets (files, folders, git diff), categories, and severities. Also handles post-scan exploration: filtering results by engine/severity/category/file, and explaining what rules mean. TRIGGER when: user says 'scan my code', 'check security issues', 'run PMD/ESLint', 'find duplicates', 'analyze Flows', 'check vulner

Instalaciones / 1h
1
GitHub Stars
1,2 mil
Actualizado
13 nov
forcedotcom
Comunidad

experience-lwc-accessibility-jest-run

Use ALWAYS when running Sa11y accessibility Jest tests for an LWC — locally before pushing, producing the command(s), running one file vs a suite, selecting tests by naming convention, saving Sa11y-rendered HTML, or reproducing a Sa11y/A11yBug failure. Covers core (Bazel; bazel test // : ) and standalone npx jest (.accessibility.test.js, @sa11y/jest). REQUIRED for a run-plan.md, a failing a11y test's exit code, or SA11Y/A11yBug/core-Bazel test paths. DO NOT TRIGGER for functional Jest tests, a11

Instalaciones / 1h
1
GitHub Stars
1,2 mil
Actualizado
13 nov
forcedotcom
Comunidad

experience-lwc-generate

Lightning Web Components with PICKLES methodology and 165-point scoring. Use this skill when the user creates or edits LWC components, builds wire service patterns, or writes Jest tests for LWC. TRIGGER when: user creates/edits LWC components, touches lwc//.js, .html, .css, .js-meta.xml files, or asks about wire service, SLDS, or Jest LWC tests. DO NOT TRIGGER when: Apex classes (use platform-apex-generate), Aura components, or Visualforce.

Instalaciones / 1h
1
GitHub Stars
1,2 mil
Actualizado
13 nov