---
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:202](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/bceb8da43dd8bc63d57932bbd905d36a1b40c949/packages/b2c-tooling-sdk/src/openshell/apply.ts#L202)

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:206](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/bceb8da43dd8bc63d57932bbd905d36a1b40c949/packages/b2c-tooling-sdk/src/openshell/apply.ts#L206)

Build the image when it is missing (default true)

***

### dockerfile

> **dockerfile**: `string`

Defined in: [packages/b2c-tooling-sdk/src/openshell/apply.ts:62](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/bceb8da43dd8bc63d57932bbd905d36a1b40c949/packages/b2c-tooling-sdk/src/openshell/apply.ts#L62)

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:60](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/bceb8da43dd8bc63d57932bbd905d36a1b40c949/packages/b2c-tooling-sdk/src/openshell/apply.ts#L60)

Container image for the sandbox

#### Inherited from

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

***

### onStep()?

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

Defined in: [packages/b2c-tooling-sdk/src/openshell/apply.ts:212](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/bceb8da43dd8bc63d57932bbd905d36a1b40c949/packages/b2c-tooling-sdk/src/openshell/apply.ts#L212)

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:210](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/bceb8da43dd8bc63d57932bbd905d36a1b40c949/packages/b2c-tooling-sdk/src/openshell/apply.ts#L210)

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:214](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/bceb8da43dd8bc63d57932bbd905d36a1b40c949/packages/b2c-tooling-sdk/src/openshell/apply.ts#L214)

Command runner (for testing)

***

### sandbox?

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

Defined in: [packages/b2c-tooling-sdk/src/openshell/apply.ts:208](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/bceb8da43dd8bc63d57932bbd905d36a1b40c949/packages/b2c-tooling-sdk/src/openshell/apply.ts#L208)

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:204](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/bceb8da43dd8bc63d57932bbd905d36a1b40c949/packages/b2c-tooling-sdk/src/openshell/apply.ts#L204)

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