Quick Start a Wix CLI App

This guide explains the minimum steps required to get a CLI app up and running using the Wix CLI.

Before you begin

Before getting started, make sure that you:

• Have Node.js (v20.11.0 or higher).
• Have Git installed and configured.
• Are logged into your Wix account. If you don't already have one, sign up for a Wix account.

Step 1 | Create a new app project

1. Run the following command to create a new app project:

   Copy

2. When asked what you would like to do, select Create a new Wix App.

3. Enter a name for your app and a folder name for your project.

   • The app name is the name that appears in your app's dashboard.
   • The folder name is the name of the directory containing your project's local files.

Once the CLI has created your app, the app's files appear in a local directory with the folder name you chose.

Your app appears in the app dashboard but isn't yet installed on a development site.

Step 2 | Test the app

1. Run the dev command to start the local development environment.

2. Select a site to install your app on for testing:

   • Pick an existing site: Designates one of your existing Wix sites.
   • Create a new Development Site: Builds a new Wix development site.

3. Press Enter to open your browser and install the application on your test site.

4. The CLI builds a local environment for your test site and provides a menu to view your app's dashboard pages in the browser.

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

Next steps

After completing the above steps, you have a simple Wix app that you can experiment with and test locally.

You can now:

• Add extensions to your app.
• Learn more about developing your app.

See also

• About the Wix CLI
• Wix CLI Development Overview
• Project structure
• CLI Command Reference