Command-Line Interface (CLI) Reference

The sfnext CLI is your primary tool for developing and deploying Storefront Next projects. It’s provided by the @salesforce/storefront-next-dev package, which is installed as a project dependency—not globally.

Storefront Next projects include pre-configured scripts in package.json for common tasks:

For commands that don’t have a package.json script, or when you need to pass specific options, run pnpm sfnext from your project’s root directory:

For example:

You can also view all available commands and options:

This works because pnpm automatically resolves binaries installed in your project’s node_modules/.bin. Running sfnext this way ensures the CLI version always matches your project’s dependencies.

The create-storefront command is the one exception—it runs before a project exists, so there’s no local node_modules to resolve from. For this command, use pnpm dlx to download and execute the package directly:

For all other commands, use pnpm sfnext from within your project.

Scaffold a new Storefront Next project. The command clones a template repository, walks you through extension selection, and configures your environment variables.

Because this command creates a new project, it’s the one CLI command you run before a project exists. Use pnpm dlx to download and run it without a prior installation:

Create a storefront interactively:

Create a storefront with a specific name:

After the command completes, follow the on-screen instructions to install dependencies and start developing:

For a walkthrough of creating a storefront with the CLI, see Explore Storefront Next Code Locally.

Start a local development server powered by Vite with full server-side rendering (SSR) support. The server includes hot module replacement (HMR) for both client and server code, and an API proxy to B2C Commerce.

Or with options:

Start the dev server:

Start the dev server on a custom port:

Start with the Node.js debugger attached:

• Runs Vite in middleware mode within an Express server for full SSR support.
• Proxies B2C Commerce API requests through /mobify/proxy/api so that you can develop against live data without CORS issues.
• Loads environment variables from your .env file.
• Prints your Commerce API configuration (short code, organization ID, site ID) at startup.

Start a local server that serves your production build. Use this to test production behavior before deploying. If no build exists, the command automatically runs pnpm build first.

The CLI command is preview. In package.json, it’s mapped to pnpm start.

Or with options:

Preview the production build:

Preview on a custom port:

Create a deployment bundle from your production build and push it to Managed Runtime (MRT). You must build your project before running this command.

Or with options:

Authenticate with Managed Runtime using one of these methods:

• Credentials file (default): The CLI reads stored credentials automatically. Use --credentials-file to specify a custom path.
• API key: Pass --api-key on the command line or set the SFCC_MRT_API_KEY environment variable.

Before you can deploy, you need a Managed Runtime project and SLAS client credentials. Use the B2C Developer Tooling CLI to create these resources.

Build and deploy to MRT:

Deploy to a specific environment and wait for completion:

Deploy with an API key:

Create a deployment bundle and save it to disk without pushing to Managed Runtime. This is useful for inspecting bundle contents or integrating with custom deployment pipelines.

The command generates two files in the output directory:

• bundle.tgz — The compressed deployment bundle.
• bundle.json — Bundle metadata (message, SSR parameters, file sizes).

Manage feature extensions for your storefront project. Extensions add pre-built functionality, such as store locators or theme switchers.

List all extensions currently installed in your project.

Install an extension from a source template repository. The CLI clones the source repository, lets you select an extension, and copies the extension files into your project.

If the extension has dependencies on other extensions, the CLI detects them and installs the full dependency chain in the correct order.

Install an extension interactively:

Install a specific extension by marker:

Remove one or more installed extensions from your project. The CLI automatically detects and removes dependent extensions.

Remove extensions interactively:

Remove specific extensions by marker:

Scaffold a new extension in your project. This command creates the extension directory structure with placeholder folders for components, hooks, locales, and routes.

The generated directory structure:

Several CLI commands read configuration from environment variables defined in your .env file.

• Build Tools — Vite configuration and build system details.
• Project Configuration — Environment variables and storefront configuration.
• B2C Developer Tooling CLI: Storefront Next — Create SLAS clients and Managed Runtime resources.