npm create @wix/new app

Creates a new Wix app project. Run this command in the parent directory where you want the project folder. The command registers a new app in your Wix account (or extends an existing app), scaffolds the chosen app template into a new local folder, and installs dependencies.

If you don't include flags, it runs in interactive mode, prompting you for an app name and letting you pick a template. To run non-interactively, use the app command together with the flags below.

For a step-by-step walkthrough, see Quick Start an App.

Note: This command is provided by the @wix/create-new package, which is invoked through npm create. It's a separate package from @wix/cli and doesn't require an existing project.

Usage

Copy

The -- separator tells npm to forward everything after it to the @wix/create-new package, instead of consuming the flags itself.

Flags

The following flags are available for the app command:

FlagDescription
--app-name <app-name>Optional. The display name for your new app. Must be 1 to 30 characters long and can't contain the reserved word wix (case-insensitive). If omitted, the CLI prompts you for an app name in interactive mode. To run non-interactively, pass this flag together with --template.
-t, --template <template-id>Optional. The ID of the app template to scaffold from. If omitted, the CLI prompts you to pick a template in interactive mode. Required whenever you pass --app-name to run non-interactively. For valid IDs, see App template IDs.
--extend-app-id <extend-app-id>The ID of an existing app to add new extensions to. If you pass this flag, the CLI scaffolds locally against that app instead of registering a new one. You can't combine it with --app-name or --template. The CLI always prompts you to pick a template, so this flag requires an interactive terminal (TTY).
-h, --helpDisplay help for the command.

App template IDs

The following CLI app templates are available. Pass the ID via --template to scaffold against the corresponding template non-interactively.

TemplateIDDescription
Custom Products Catalog24493a0d-18f2-4f68-b6d5-55992cef7daaAdd or remove products via a dashboard page using Stores APIs.
Mixpanel Analyticsc442b755-2276-4336-918a-915865a9fa2bBuild data-driven apps using an embedded script and dashboard page.
Site Popup46746ee0-e0b0-4971-be34-f3ea94dd979bDesign interactive popups via a dashboard page.
Inventory Countdown2ff7a5ae-d116-4c06-9394-7d7493428d0eDevelop a Wix Stores site plugin that is added to product pages.
Chart Widget5fcf03b8-46ba-499b-8dbb-40ecf811acebCreate a widget with dynamic and customizable charts.

Examples

Scaffold an app interactively, with prompts for the app name and template:

Copy

Scaffold an app non-interactively, with a known template ID:

Copy

Add new extensions to an app you already own. This form requires an interactive terminal:

Copy

After the command runs

The command creates a new folder for your app project. The folder follows the standard project structure for Wix CLI projects.

In addition to scaffolding the standard layout, this command:

  • Registers a new app in your Wix account, unless you pass --extend-app-id. The new app appears in your account under Custom Apps.
  • Populates wix.config.json with appId, projectId, and projectType.
  • Creates a Git repository with an initial commit.

To start a local development environment, run wix dev.

Did this help?