LinuxCommandLibrary

sfdk-emulator-set

Set Salesforce Function SDK emulator environment variables

TLDR

Set a property

$ sfdk emulator set [name] [property]=[value]
copy

Show emulator properties
$ sfdk emulator show [name]
copy

SYNOPSIS

sfdk-emulator-set [--option1 value1] [--option2 value2]...

PARAMETERS

--sdk-path <path>
    Specifies the path to the SDK directory. Mandatory.

--emulator-type <type>
    Specifies the type of emulator to configure (e.g., Android, iOS, custom). Defaults to the primary type if not provided.

--emulator-version <version>
    Specifies the version of the emulator image to use. If not provided, the latest or default version is used.

--install
    Installs the required emulator images and dependencies. Requires network access.

--uninstall
    Uninstalls installed emulator images and dependencies.

--verbose
    Enables verbose output during the setup process.

--help
    Displays help information about the command.

DESCRIPTION

The `sfdk-emulator-set` command is a utility designed to configure the environment for running emulators within a Software Development Kit (SDK) framework. It typically handles setting up necessary environment variables, creating default configurations, and ensuring the emulator can communicate with other components of the SDK. This command streamlines the process of working with emulated environments, allowing developers to quickly test and debug applications without the need for physical hardware. It might automate tasks such as downloading emulator images, configuring network settings for the emulator, and integrating the emulator with debugging tools.

CAVEATS

This command requires appropriate permissions to install software and modify system environment variables. Incorrect usage may lead to emulator malfunction or system instability.

NETWORK CONFIGURATION

The command automatically configures the emulator's network interface to allow communication with the host machine and potentially external networks. This may involve setting up port forwarding or bridging depending on the emulator type and settings.

Verify firewall settings if you're experiencing network issues with the emulator after using this command.

ENVIRONMENT VARIABLES

The `sfdk-emulator-set` command will likely set or modify environment variables, such as EMULATOR_HOME, ANDROID_HOME, or similar, to point to the correct locations of emulator components and SDK tools.

Run `env` to inspect the changes after executing the command.

SEE ALSO

emulator(1), adb(1)

Copied to clipboard