mirror of
https://github.com/forcedotcom/afv-library.git
synced 2026-07-30 11:43:26 +08:00
5c40e3b63e
* add switch-org skill
Adds a new skill for switching the active Salesforce org via `sf config set target-org`, defaulting to local project scope with optional `--global` support.
* address PR review feedback on switch-org skill
- rename skill and directory to switching-org (gerund convention)
- rewrite description to follow "Use this skill when..." pattern
- add compatibility and metadata frontmatter fields
- rename ## Usage to ## When to Use This Skill
- consolidate Behavior, Steps, and Canonical Examples into single ## Steps section
- remove Purpose section (duplicated description)
- remove .sf/config.json implementation detail
- fix escaped \# in documentation URL
- rephrase --local/--scope note for clarity
* fix: skill best practice improvements for switching-org
- Fix description to use third-person ("This skill should be used when...")
- Remove redundant "When to Use This Skill" body section (duplicated description)
* fix: improve switching-org skill description, steps, and scope guidance
* remove author
* fix: clarify verification step and confirmation format in switching-org skill
* address second round of PR review feedback
- remove redundant h1 and repeated description sentence
- clarify sf config get --json does not return scope info
- move docs link into Notes section
- add SF_TARGET_ORG env var override note
29 lines
2.1 KiB
Markdown
29 lines
2.1 KiB
Markdown
---
|
|
name: switching-org
|
|
description: Switches the active Salesforce org (default target-org) using the Salesforce CLI. Use whenever someone wants to change which org CLI commands run against — whether they say "switch org", "change default org", "set my org to", "use alias", "point to", or describe wanting to work against a specific org, scratch org, sandbox, or production.
|
|
compatibility: Salesforce CLI (sf) v2+
|
|
metadata:
|
|
version: "1.0"
|
|
---
|
|
|
|
## Steps
|
|
|
|
1. Identify the org: the user provides a username or alias (`orgIdentifier`). If not provided, run `sf org list` to show authenticated orgs and ask the user which one to use.
|
|
2. Set the default org:
|
|
- Local (default): `sf config set target-org <orgIdentifier>`
|
|
- Applies only within the current project directory. Use this for normal project work.
|
|
- Global (only if user explicitly requests): `sf config set target-org <orgIdentifier> --global`
|
|
- Applies system-wide across all directories. Use when working outside a project or when the user asks for global scope.
|
|
- If this fails, report the error and suggest running `sf org login web` if the org may not be authorized.
|
|
3. Verify:
|
|
- `sf config get target-org --json`
|
|
- Note: the JSON output does not include a scope/location field — it cannot confirm whether the value is local or global. Confirm the value only, e.g.: `target-org is now set to: <value>`
|
|
- If it fails, report the error and advise running `sf config get target-org`.
|
|
|
|
## Notes
|
|
|
|
- Unified CLI uses keys like `target-org` and `target-dev-hub`. Legacy sfdx keys (`defaultusername`, `defaultdevhubusername`) are deprecated in this context.
|
|
- The sf CLI does not have `--local` or `--scope` flags for config set. Local scope is the default behavior.
|
|
- If the org does not change after setting the config, check whether `SF_TARGET_ORG` is set — environment variables override config values.
|
|
- Salesforce CLI config (unified) reference: https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_config_commands_unified.htm#cli_reference_config_set_unified
|