rename config to inspect

Author: clavery

.changeset/rename-setup-config-to-inspect.md

@@ -0,0 +1,5 @@
+---
+'@salesforce/b2c-cli': patch
+---
+
+Rename `setup config` to `setup inspect` to better reflect its read-only purpose. `setup config` continues to work as an alias.

docs/cli/setup.md

@@ -6,14 +6,16 @@ description: Commands for viewing configuration, installing AI agent skills, and
 
 Commands for viewing configuration and setting up the development environment.
 
-## b2c setup config
+## b2c setup inspect
 
 Display the resolved configuration from all sources, showing which values are set and where they came from. Useful for debugging configuration issues.
 
+**Alias:** `b2c setup config`
+
 ### Usage
 
 ```bash
-b2c setup config [FLAGS]
+b2c setup inspect [FLAGS]
 ```
 
 ### Flags
@@ -27,16 +29,16 @@ b2c setup config [FLAGS]
 
 ```bash
 # Display resolved configuration (sensitive values masked)
-b2c setup config
+b2c setup inspect
 
 # Display configuration with sensitive values unmasked
-b2c setup config --unmask
+b2c setup inspect --unmask
 
 # Output as JSON for scripting
-b2c setup config --json
+b2c setup inspect --json
 
 # Debug configuration with a specific instance
-b2c setup config -i staging
+b2c setup inspect -i staging
 ```
 
 ### Output

docs/guide/configuration.md

@@ -332,17 +332,17 @@ The CLI will try each method in order until one succeeds.
 
 ## Debugging Configuration
 
-Use `b2c setup config` to view the resolved configuration and see which source provided each value:
+Use `b2c setup inspect` to view the resolved configuration and see which source provided each value:
 
 ```bash
 # Display resolved configuration (sensitive values masked)
-b2c setup config
+b2c setup inspect
 
 # Show actual sensitive values
-b2c setup config --unmask
+b2c setup inspect --unmask
 
 # Output as JSON
-b2c setup config --json
+b2c setup inspect --json
 ```
 
 This command helps troubleshoot issues like:
@@ -351,7 +351,7 @@ This command helps troubleshoot issues like:
 - Understanding credential source priority
 - Identifying hostname mismatch protection triggers
 
-See [setup config](/cli/setup#b2c-setup-config) for full documentation.
+See [setup inspect](/cli/setup#b2c-setup-inspect) for full documentation.
 
 ## Next Steps
 

…ges/b2c-cli/src/commands/setup/config.ts …es/b2c-cli/src/commands/setup/inspect.tspackages/b2c-cli/src/commands/setup/config.ts renamed to packages/b2c-cli/src/commands/setup/inspect.ts packages/b2c-cli/src/commands/setup/config.ts renamed to packages/b2c-cli/src/commands/setup/inspect.ts

@@ -15,9 +15,9 @@ import {withDocs} from '../../i18n/index.js';
 const SENSITIVE_FIELDS = new Set<keyof NormalizedConfig>(['clientSecret', 'mrtApiKey', 'password']);
 
 /**
- * JSON output structure for the config command.
+ * JSON output structure for the inspect command.
  */
-interface SetupConfigResponse {
+interface SetupInspectResponse {
   config: Record<string, unknown>;
   sources: ConfigSourceInfo[];
   warnings?: string[];
@@ -65,8 +65,10 @@ function getDisplayValue(field: string, value: unknown, unmask: boolean): string
 /**
  * Command to display resolved configuration.
  */
-export default class SetupConfig extends BaseCommand<typeof SetupConfig> {
-  static description = withDocs('Display resolved configuration', '/cli/setup.html#b2c-setup-config');
+export default class SetupInspect extends BaseCommand<typeof SetupInspect> {
+  static aliases = ['setup:config'];
+
+  static description = withDocs('Display resolved configuration', '/cli/setup.html#b2c-setup-inspect');
 
   static enableJsonFlag = true;
 
@@ -84,7 +86,7 @@ export default class SetupConfig extends BaseCommand<typeof SetupConfig> {
     }),
   };
 
-  async run(): Promise<SetupConfigResponse> {
+  async run(): Promise<SetupInspectResponse> {
     const {values, sources, warnings} = this.resolvedConfig;
     const unmask = this.flags.unmask;
 
@@ -96,7 +98,7 @@ export default class SetupConfig extends BaseCommand<typeof SetupConfig> {
       }
     }
 
-    const result: SetupConfigResponse = {
+    const result: SetupInspectResponse = {
       config: outputConfig,
       sources,
       warnings: warnings.length > 0 ? warnings.map((w) => w.message) : undefined,

…c-cli/test/commands/setup/config.test.ts …-cli/test/commands/setup/inspect.test.tspackages/b2c-cli/test/commands/setup/config.test.ts renamed to packages/b2c-cli/test/commands/setup/inspect.test.ts packages/b2c-cli/test/commands/setup/config.test.ts renamed to packages/b2c-cli/test/commands/setup/inspect.test.ts

@@ -7,7 +7,7 @@
 import {expect} from 'chai';
 import sinon from 'sinon';
 
-import SetupConfig from '../../../src/commands/setup/config.js';
+import SetupInspect from '../../../src/commands/setup/inspect.js';
 import {isolateConfig, restoreConfig} from '@salesforce/b2c-tooling-sdk/test-utils';
 import {runSilent} from '../../helpers/test-setup.js';
 import type {ConfigSourceInfo, NormalizedConfig} from '@salesforce/b2c-tooling-sdk/config';
@@ -52,9 +52,9 @@ function stubResolvedConfig(
 }
 
 /**
- * Unit tests for setup config command.
+ * Unit tests for setup inspect command.
  */
-describe('setup config', () => {
+describe('setup inspect', () => {
   beforeEach(() => {
     isolateConfig();
   });
@@ -66,22 +66,26 @@ describe('setup config', () => {
 
   describe('command structure', () => {
     it('should have correct description', () => {
-      expect(SetupConfig.description).to.be.a('string');
-      expect(SetupConfig.description).to.include('configuration');
+      expect(SetupInspect.description).to.be.a('string');
+      expect(SetupInspect.description).to.include('configuration');
     });
 
     it('should enable JSON flag', () => {
-      expect(SetupConfig.enableJsonFlag).to.be.true;
+      expect(SetupInspect.enableJsonFlag).to.be.true;
     });
 
     it('should have unmask flag', () => {
-      expect(SetupConfig.flags).to.have.property('unmask');
+      expect(SetupInspect.flags).to.have.property('unmask');
+    });
+
+    it('should have setup:config alias', () => {
+      expect(SetupInspect.aliases).to.include('setup:config');
     });
   });
 
   describe('masking', () => {
     it('should mask password by default', async () => {
-      const command = new SetupConfig([], {} as any);
+      const command = new SetupInspect([], {} as any);
       (command as any).flags = {unmask: false};
       stubJsonEnabled(command, true);
       stubCommandConfigAndLogger(command);
@@ -97,7 +101,7 @@ describe('setup config', () => {
     });
 
     it('should mask clientSecret by default', async () => {
-      const command = new SetupConfig([], {} as any);
+      const command = new SetupInspect([], {} as any);
       (command as any).flags = {unmask: false};
       stubJsonEnabled(command, true);
       stubCommandConfigAndLogger(command);
@@ -113,7 +117,7 @@ describe('setup config', () => {
     });
 
     it('should mask mrtApiKey by default', async () => {
-      const command = new SetupConfig([], {} as any);
+      const command = new SetupInspect([], {} as any);
       (command as any).flags = {unmask: false};
       stubJsonEnabled(command, true);
       stubCommandConfigAndLogger(command);
@@ -129,7 +133,7 @@ describe('setup config', () => {
     });
 
     it('should show REDACTED for short secrets', async () => {
-      const command = new SetupConfig([], {} as any);
+      const command = new SetupInspect([], {} as any);
       (command as any).flags = {unmask: false};
       stubJsonEnabled(command, true);
       stubCommandConfigAndLogger(command);
@@ -143,7 +147,7 @@ describe('setup config', () => {
     });
 
     it('should unmask values when --unmask flag is provided', async () => {
-      const command = new SetupConfig([], {} as any);
+      const command = new SetupInspect([], {} as any);
       (command as any).flags = {unmask: true};
       stubJsonEnabled(command, true);
       stubCommandConfigAndLogger(command);
@@ -170,7 +174,7 @@ describe('setup config', () => {
 
   describe('output formatting', () => {
     it('should return structured JSON in --json mode', async () => {
-      const command = new SetupConfig([], {} as any);
+      const command = new SetupInspect([], {} as any);
       (command as any).flags = {unmask: false};
       stubJsonEnabled(command, true);
       stubCommandConfigAndLogger(command);
@@ -199,7 +203,7 @@ describe('setup config', () => {
     });
 
     it('should display warnings if present', async () => {
-      const command = new SetupConfig([], {} as any);
+      const command = new SetupInspect([], {} as any);
       (command as any).flags = {unmask: false};
       stubJsonEnabled(command, true);
       stubCommandConfigAndLogger(command);
@@ -216,7 +220,7 @@ describe('setup config', () => {
     });
 
     it('should handle empty config gracefully', async () => {
-      const command = new SetupConfig([], {} as any);
+      const command = new SetupInspect([], {} as any);
       (command as any).flags = {unmask: false};
       stubJsonEnabled(command, true);
       stubCommandConfigAndLogger(command);
@@ -229,7 +233,7 @@ describe('setup config', () => {
     });
 
     it('should handle array values (scopes)', async () => {
-      const command = new SetupConfig([], {} as any);
+      const command = new SetupInspect([], {} as any);
       (command as any).flags = {unmask: false};
       stubJsonEnabled(command, true);
       stubCommandConfigAndLogger(command);
@@ -245,7 +249,7 @@ describe('setup config', () => {
 
   describe('source tracking', () => {
     it('should track which source provided each field', async () => {
-      const command = new SetupConfig([], {} as any);
+      const command = new SetupInspect([], {} as any);
       (command as any).flags = {unmask: false};
       stubJsonEnabled(command, true);
       stubCommandConfigAndLogger(command);
@@ -278,7 +282,7 @@ describe('setup config', () => {
     });
 
     it('should handle fieldsIgnored correctly', async () => {
-      const command = new SetupConfig([], {} as any);
+      const command = new SetupInspect([], {} as any);
       (command as any).flags = {unmask: false};
       stubJsonEnabled(command, true);
       stubCommandConfigAndLogger(command);
@@ -314,7 +318,7 @@ describe('setup config', () => {
 
   describe('human-readable output', () => {
     it('should display formatted info in non-JSON mode', async () => {
-      const command = new SetupConfig([], {} as any);
+      const command = new SetupInspect([], {} as any);
       (command as any).flags = {unmask: false};
       stubJsonEnabled(command, false);
       stubCommandConfigAndLogger(command);
@@ -347,7 +351,7 @@ describe('setup config', () => {
     });
 
     it('should show unmask warning when --unmask is used', async () => {
-      const command = new SetupConfig([], {} as any);
+      const command = new SetupInspect([], {} as any);
       (command as any).flags = {unmask: true};
       stubJsonEnabled(command, false);
       stubCommandConfigAndLogger(command);

skills/b2c-cli/skills/b2c-config/SKILL.md

@@ -5,13 +5,13 @@ description: View and debug b2c CLI configuration and understand where credentia
 
 # B2C Config Skill
 
-Use the `b2c setup config` command to view the resolved configuration and understand where each value comes from. This is essential for debugging configuration issues and verifying that the CLI is using the correct settings.
+Use the `b2c setup inspect` command to view the resolved configuration and understand where each value comes from. This is essential for debugging configuration issues and verifying that the CLI is using the correct settings.
 
-> **Tip:** If `b2c` is not installed globally, use `npx @salesforce/b2c-cli` instead (e.g., `npx @salesforce/b2c-cli setup config`).
+> **Tip:** `b2c setup config` still works as an alias. If `b2c` is not installed globally, use `npx @salesforce/b2c-cli` instead (e.g., `npx @salesforce/b2c-cli setup inspect`).
 
 ## When to Use
 
-Use `b2c setup config` when you need to:
+Use `b2c setup inspect` when you need to:
 
 - Verify which configuration file is being used
 - Check if environment variables are being read correctly
@@ -26,33 +26,33 @@ Use `b2c setup config` when you need to:
 
 ```bash
 # Display resolved configuration (sensitive values masked by default)
-b2c setup config
+b2c setup inspect
 
 # View configuration for a specific instance from dw.json
-b2c setup config -i staging
+b2c setup inspect -i staging
 
 # View configuration with a specific config file
-b2c setup config --config /path/to/dw.json
+b2c setup inspect --config /path/to/dw.json
 ```
 
 ### Debug Sensitive Values
 
 ```bash
 # Show actual passwords, secrets, and API keys (use with caution)
-b2c setup config --unmask
+b2c setup inspect --unmask
 ```
 
 ### JSON Output for Scripting
 
 ```bash
 # Output as JSON for parsing in scripts
-b2c setup config --json
+b2c setup inspect --json
 
 # Pretty-print with jq
-b2c setup config --json | jq '.config'
+b2c setup inspect --json | jq '.config'
 
 # Check which sources are loaded
-b2c setup config --json | jq '.sources'
+b2c setup inspect --json | jq '.sources'
 ```
 
 ## Understanding the Output