Quick Start with the Wix CLI

Get a Wix-managed headless project up and running with the Wix CLI. You'll get a frontend site and private app integrated with a headless project.

Before you begin

Make sure that you have:

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

Step 1 | Create a new headless project

1. Open a terminal and navigate to the folder where you want to create your project.
2. Run the following command to create a new headless project:

If prompted to install the @wix/create-new package, confirm it. 3. Enter the name of your business. This is the name of your headless project on Wix. The CLI creates a Wix Headless project for you with this name and adds it to your Wix sites list. 4. Select an initial template for your project. For a list of available templates, see Wix-Managed Headless Templates. 5. Enter a folder name for your project. The CLI generates the local code files for your project in a folder with that name. 6. Wait while the CLI generates your project. It installs dependencies, initializes a Git repository, and configures your files, then builds and publishes your site and displays your live site URL.

Step 2 | Test the project

1. Navigate to your project folder.
2. Run the dev command to start the local development environment:

The CLI builds a local environment for your project and provides links to view your site and dashboard. The development environment supports hot reloading, so any changes you make to your code are immediately reflected in the browser. 3. Click the Site link to confirm your project is running locally. You can also click the Dashboard link to open your project's Wix dashboard. 4. Close the local development environment when you're done.

Step 3 | Keep building

Keep adding features and adjusting the design.

See also

• Create a Project with the Wix CLI
• About the Wix CLI
• Add extensions to your project
• About Wix-Managed Headless