Developer Preview — This project is in active development. APIs may change. Provide feedback
Skip to content

@salesforce/b2c-tooling-sdk / cli / loadConfig

Function: loadConfig()

loadConfig(flags, options, pluginSources): NormalizedConfig

Defined in: packages/b2c-tooling-sdk/src/cli/config.ts:103

Loads configuration with precedence: CLI flags/env vars > dw.json > ~/.mobify

OCLIF handles environment variables automatically via flag env properties. The flags parameter already contains resolved env var values.

Uses resolveConfig internally for consistent behavior across CLI and SDK.

Parameters

flags

Partial<ResolvedConfig> = {}

Configuration values from CLI flags/env vars

options

LoadConfigOptions = {}

Loading options

pluginSources

PluginSources = {}

Optional sources from CLI plugins (via b2c:config-sources hook)

Returns

NormalizedConfig

Resolved configuration values

Examples

typescript
// In a CLI command
const config = loadConfig(
  { hostname: this.flags.server, clientId: this.flags['client-id'] },
  { instance: this.flags.instance }
);
typescript
// For richer API with factory methods, use resolveConfig directly:
import { resolveConfig } from '@salesforce/b2c-tooling-sdk/config';

const config = resolveConfig(flags, options);
if (config.hasB2CInstanceConfig()) {
  const instance = config.createB2CInstance();
}

All rights reserved.