Mintlify Sandbox

Coding Examples

Overview

Sled Tests

Go Headless

Studio Two

Dashboard Extensions

Backend Extensions

Site Extensions

Extend Websites with SDK

Wix APIs and References

Build Apps

Wix Design System (WDS)

Client (Deprecated)

API Preview

Wix CLI

Contexts

Ricos

Extend Websites with Velo

API Reference

Velo

Picasso

# Wix CLI for Apps Command Reference

With the Wix CLI, you can develop, test, and release Wix apps from your terminal. This reference documents the commands for creating and working in app projects.

The sections of this article are organized by command type, and each section describes the syntax of its commands. Every command accepts `-h` and `--help`, which print the command's usage and flags.

The commands you can use depend on where you run them:

- **Outside a project:** The [project creation command](fallback::https://dev.wix.com/docs/wix-cli/cli-for-apps/command-reference/introduction#project-creation-commands).
- **In an app project:** The [project commands](fallback::https://dev.wix.com/docs/wix-cli/cli-for-apps/command-reference/introduction#project-commands).
- **Anywhere:** The [global commands](fallback::https://dev.wix.com/docs/wix-cli/cli/command-reference/introduction).

## Project creation commands

This command scaffolds a new project. It's provided by the [`@wix/create-new`](fallback::https://www.npmjs.com/package/@wix/create-new) package, so it runs through `npm create`, not as a `wix` command, before a project exists locally.

| Command | Description |
|---------|-------------|
| [npm create @wix/new app](fallback::https://dev.wix.com/docs/wix-cli/cli-for-apps/command-reference/project-creation-commands/create-app) | Creates a new Wix app project, including registering a new app in your account (or extending an existing one) and scaffolding from a template. |

### Command syntax

The project creation command uses this syntax:

```bash
npm create @wix/new@latest -- app [flags]
```

Angle brackets mark a required part, and square brackets mark an optional part. Don't type the brackets.

The `--` separator forwards everything after it to the `@wix/create-new` package instead of consuming the flags itself.

## Project commands

These commands operate on a project that uses the [app project structure](fallback::https://dev.wix.com/docs/wix-cli/cli-for-apps/project-structure/about-the-app-project-structure). Run them in the project's folder.

| Command | Description |
|---------|-------------|
| [dev](fallback::https://dev.wix.com/docs/wix-cli/cli-for-apps/command-reference/project-commands/dev) | Starts a local development environment that serves your project. |
| [dev-site](fallback::https://dev.wix.com/docs/wix-cli/cli-for-apps/command-reference/project-commands/dev-site) | Manages the development site used by the current app. |
| [build](fallback::https://dev.wix.com/docs/wix-cli/cli-for-apps/command-reference/project-commands/build) | Builds your project. |
| [generate](fallback::https://dev.wix.com/docs/wix-cli/cli-for-apps/command-reference/project-commands/generate) | Generates an extension for your project. |
| [schema](fallback::https://dev.wix.com/docs/wix-cli/cli-for-apps/command-reference/project-commands/schema) | Prints a JSON schema of the available extension types and their required inputs. |
| [preview](fallback::https://dev.wix.com/docs/wix-cli/cli-for-apps/command-reference/project-commands/preview) | Creates an online preview of your built project. |
| [release](fallback::https://dev.wix.com/docs/wix-cli/cli-for-apps/command-reference/project-commands/release) | Starts a process that guides you through releasing your project. |
| [env](fallback::https://dev.wix.com/docs/wix-cli/cli-for-apps/command-reference/project-commands/env) | Manages your project's environment variables on Wix's servers. |

### Command syntax

Project commands follow this general form:

```bash
wix app <command> [subcommand] [flags]
```

Angle brackets mark a required part, and square brackets mark an optional part. Don't type the brackets.

Where:
- `<command>` is the primary action (for example, `dev`, `build`, `release`)
- `[subcommand]` is a secondary action for commands that have subcommands (for example, `set` in `wix app env set`)
- `[flags]` are parameters that modify the command's behavior

When a command requires a subcommand, its Usage section shows `<subcommand>`. Running the command without a subcommand prints the command's help and exits with an error code.