In This Article

Wix CLI for Apps Command Reference

This article documents the CLI commands for building Wix Apps.

For a detailed explanation of the process and how to initially create an app, see our Quick Start article.

Command overview

Category	Command	Description
CLI for Apps	dev	Starts a local development environment that serves your app.
	generate	Generates an extension for your app.
	build	Builds your app.
	preview	Creates an online preview of your built app.
	release	Starts a process that guides you through releasing a new app version.
	create-version	Deprecated, use release instead.
	logs	Shows backend logs from your app.
Global CLI	login	Logs in to your Wix account.
	logout	Logs out of your Wix account.
	telemetry	Opts in or out of sending anonymous usage information (telemetry) to Wix.
	whoami	Displays the email address of the logged-in Wix user.

dev

Starts a local development environment that serves your app. Follow the prompts to open the different parts of your app on your development site in your browser.

The development environment is set up for hot reloading, so any changes you make to your code are immediately reflected in the browser.

Copy

Options

Option	Alias	Description
`--https`	`-s`	Starts your local development server on HTTPS. Use this flag if your browser does not allow iframes that contain HTTP pages within HTTPS pages.

generate

Starts a process that guides you through adding an extension to your app.

After selecting an extension you will be prompted for relevant configuration details, then your extension will be generated in your app's local files.

Copy

build

Builds your app.

You must build your app before:

Creating a version
Previewing your app

Copy

preview

Creates an online preview of your built app and provides an inline link to an app preview URL in the console.

An app preview URL is a URL you can share with team members who are collaborators on your development site. It directs to a dashboard page where they can preview and test your app.

By default, the code for your app preview is hosted on Wix's servers.

Copy

Options

Option	Alias	Description
`--site <site-id>`	`-s <site-id>`	Allows you to set the `site` used for application preview URLs. If this flag is not provided, the `site-id` defaults to the currently-selected development site. You can get the ID of a site from the site URL in your browser. For example, the site ID appears after the `/dashboard/` part of this URL:
`--base-url <url>`		Sets the base URL for uploading your static files to an external CDN. If this flag is not provided, the code for your preview will be hosted on Wix's servers.

Note: The release command was added to v1.1.68 of the CLI, published on Feb 23, 2025. If the release command is missing, update your CLI dependencies to the latest version and add the new command to your package.json file.

Starts a process that guides you through releasing a new app version. You can view your app versions in the app dashboard.

Once the app version is released, you can submit it for review to publish it to the Wix App Market. If you choose not to list your app in the Wix App Market, you can distribute your app by sharing an install link or install it directly on a site within your account.

To learn more about app versions, see App Versions and Deployment.

Copy

Options

Option	Alias	Description
`--site <site-id>`	`-s <site-id>`	The site ID to use for application preview URLs. Defaults to the current selected development site.
`--base-url <url>`		Sets the base URL for uploading your static files to an external CDN. If this flag isn't provided, the code for your app is hosted on Wix's servers.
`--comment <comment>`	`-c <comment>`	The comment for your release version. Not visible to users.
`--version-type <type>`	`-t <type>`	The type of version you would like to create. Accepted values for `<type>`: `major`, `minor`.
`--approve-minor`	`-y`	Approve minor version release automatically.

create-version

Deprecation Notice

The create-version command has been replaced by the release command. The create-version command will be supported for a limited time to allow you to switch to the new command.

Starts a process that guides you through creating a new app version. You can view your app versions in the app dashboard.

Once the app version is created, you can submit it for review to publish it to the Wix App Market. If you choose not to list your app in the Wix App Market, you can distribute your app by sharing an install link or install it directly on a site within your account.

To learn more about app versions, see App Versions and Deployment.

Copy

Options

Option	Alias	Description
`--version-type <type>`	`-t <type>`	Specifies the type of version to create. Accepted values for `<type>`: `major`, `minor`.
`--approve-preview`	`-y`	Automatically approves continuing with the publishing process after the preview is provided. Without this flag, you are asked for approval.
`--base-url <url>`		Sets the base URL for uploading your static files to an external CDN. If this flag isn't provided, the code for your app is hosted on Wix's servers.

logs

Shows backend logs of a selected version of your app.

Copy

Options

Option	Alias	Description
yarn `--version <version>` npm `-- --version <version>`		Required. The version of the app to show logs for. For example, `--version 1.0.0`

Logs in to your Wix account.

Copy

logout

Logs out of your Wix account.

Note: To switch to another Wix account:

Run wix logout.
Run wix login, then click the link provided.
Click Log in with another account.

Copy

telemetry

Opts in or out of sending anonymous usage information (telemetry) to Wix.

Copy

whoami

Displays the email address of the logged-in Wix user.

Copy

Did this help?