---
editLink: false
lastUpdated: false
---

[@salesforce/b2c-tooling-sdk](../../modules.md) / [openshell](../index.md) / ApplyOpenShellSetupOptions

# Interface: ApplyOpenShellSetupOptions

Defined in: [packages/b2c-tooling-sdk/src/openshell/apply.ts:234](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/1cc5681b8c76554833dc7a40097f33641882a372/packages/b2c-tooling-sdk/src/openshell/apply.ts#L234)

Options for [applyOpenShellSetup](../functions/applyOpenShellSetup.md).

## Extends

- [`OpenShellApplyOptions`](OpenShellApplyOptions.md)

## Properties

### build?

> `optional` **build**: `boolean`

Defined in: [packages/b2c-tooling-sdk/src/openshell/apply.ts:238](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/1cc5681b8c76554833dc7a40097f33641882a372/packages/b2c-tooling-sdk/src/openshell/apply.ts#L238)

Build the image when it is missing (default true)

***

### dockerfile

> **dockerfile**: `string`

Defined in: [packages/b2c-tooling-sdk/src/openshell/apply.ts:83](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/1cc5681b8c76554833dc7a40097f33641882a372/packages/b2c-tooling-sdk/src/openshell/apply.ts#L83)

Dockerfile content used when the image must be built

#### Inherited from

[`OpenShellApplyOptions`](OpenShellApplyOptions.md).[`dockerfile`](OpenShellApplyOptions.md#dockerfile)

***

### image

> **image**: `string`

Defined in: [packages/b2c-tooling-sdk/src/openshell/apply.ts:81](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/1cc5681b8c76554833dc7a40097f33641882a372/packages/b2c-tooling-sdk/src/openshell/apply.ts#L81)

Container image for the sandbox

#### Inherited from

[`OpenShellApplyOptions`](OpenShellApplyOptions.md).[`image`](OpenShellApplyOptions.md#image)

***

### onEnvironmentChanged()?

> `optional` **onEnvironmentChanged**: (`names`) => `void`

Defined in: [packages/b2c-tooling-sdk/src/openshell/apply.ts:250](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/1cc5681b8c76554833dc7a40097f33641882a372/packages/b2c-tooling-sdk/src/openshell/apply.ts#L250)

Called when an existing sandbox is updated but its environment variables
(such as `SFCC_SAFETY_LEVEL`) differ from the setup. They apply only when
the sandbox is recreated.

#### Parameters

##### names

`string`[]

#### Returns

`void`

***

### onStep()?

> `optional` **onStep**: (`step`) => `void`

Defined in: [packages/b2c-tooling-sdk/src/openshell/apply.ts:244](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/1cc5681b8c76554833dc7a40097f33641882a372/packages/b2c-tooling-sdk/src/openshell/apply.ts#L244)

Called before each step runs

#### Parameters

##### step

[`OpenShellStep`](OpenShellStep.md)

#### Returns

`void`

***

### recreate?

> `optional` **recreate**: `boolean`

Defined in: [packages/b2c-tooling-sdk/src/openshell/apply.ts:242](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/1cc5681b8c76554833dc7a40097f33641882a372/packages/b2c-tooling-sdk/src/openshell/apply.ts#L242)

Delete and recreate an existing sandbox (to apply provider or environment changes)

***

### run?

> `optional` **run**: [`CommandRunner`](../type-aliases/CommandRunner.md)

Defined in: [packages/b2c-tooling-sdk/src/openshell/apply.ts:252](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/1cc5681b8c76554833dc7a40097f33641882a372/packages/b2c-tooling-sdk/src/openshell/apply.ts#L252)

Command runner (for testing)

***

### sandbox?

> `optional` **sandbox**: `boolean`

Defined in: [packages/b2c-tooling-sdk/src/openshell/apply.ts:240](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/1cc5681b8c76554833dc7a40097f33641882a372/packages/b2c-tooling-sdk/src/openshell/apply.ts#L240)

Create the sandbox, or update the policy of an existing one (default true)

***

### secrets

> **secrets**: `Record`\<`string`, `string` \| `undefined`\>

Defined in: [packages/b2c-tooling-sdk/src/openshell/apply.ts:236](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/1cc5681b8c76554833dc7a40097f33641882a372/packages/b2c-tooling-sdk/src/openshell/apply.ts#L236)

Secret values keyed by environment variable name (e.g. `SFCC_CLIENT_SECRET`)