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

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

# openshell

Run the B2C tooling inside an NVIDIA OpenShell sandbox.

Builds provider profiles, providers, and a network policy from a resolved
B2C configuration, then applies them with the `openshell` CLI. Secrets stay
on the gateway; the sandbox receives placeholders.

## Example

```typescript
import {resolveConfig} from '@salesforce/b2c-tooling-sdk/config';
import {
  applyOpenShellSetup,
  buildOpenShellDockerfile,
  buildOpenShellSetup,
  writeOpenShellFiles,
} from '@salesforce/b2c-tooling-sdk/openshell';

const config = resolveConfig().values;
const setup = buildOpenShellSetup(config, {accessLevel: 'READ_ONLY'});
const options = {image: 'b2c-openshell:latest', dockerfile: buildOpenShellDockerfile()};
const files = await writeOpenShellFiles(setup, '.openshell/b2c', options);
await applyOpenShellSetup(setup, files, {...options, secrets: {SFCC_CLIENT_SECRET: config.clientSecret!}});
```

## Classes

- [OpenShellCommandError](classes/OpenShellCommandError.md)

## Interfaces

- [ApplyOpenShellSetupOptions](interfaces/ApplyOpenShellSetupOptions.md)
- [CommandResult](interfaces/CommandResult.md)
- [OpenShellApplyOptions](interfaces/OpenShellApplyOptions.md)
- [OpenShellFiles](interfaces/OpenShellFiles.md)
- [OpenShellProfile](interfaces/OpenShellProfile.md)
- [OpenShellProvider](interfaces/OpenShellProvider.md)
- [OpenShellSetup](interfaces/OpenShellSetup.md)
- [OpenShellSetupOptions](interfaces/OpenShellSetupOptions.md)
- [OpenShellStep](interfaces/OpenShellStep.md)

## Type Aliases

- [CommandRunner](type-aliases/CommandRunner.md)
- [OpenShellAccessLevel](type-aliases/OpenShellAccessLevel.md)

## Variables

- [OPENSHELL\_ACCESS\_LEVELS](variables/OPENSHELL_ACCESS_LEVELS.md)
- [OPENSHELL\_SAFETY\_CONFIG\_PATH](variables/OPENSHELL_SAFETY_CONFIG_PATH.md)
- [runCommand](variables/runCommand.md)

## Functions

- [applyOpenShellSetup](functions/applyOpenShellSetup.md)
- [buildOpenShellDockerfile](functions/buildOpenShellDockerfile.md)
- [buildOpenShellSetup](functions/buildOpenShellSetup.md)
- [formatOpenShellScript](functions/formatOpenShellScript.md)
- [secretNeedsBodyAuth](functions/secretNeedsBodyAuth.md)
- [writeOpenShellFiles](functions/writeOpenShellFiles.md)