The Wix CLI is a tool that allows you to work with your Wix site from your computer's terminal.
The CLI is an npm or yarn package that you install on your computer. Before setting up the CLI, make sure your site is connected to GitHub and your site's repository is cloned on your computer.
Open your computer's terminal.
Run npm install -g @wix/cli or yarn global add @wix/cli.
Once you've installed the CLI globally, you can use it with any Wix site repos on your computer.
The CLI supports the following commands:
Displays a list of supported CLI commands in the terminal.
You can also run wix [command] -h to get detailed help for a command.
Opens a site's Local Editor.
For more information, see Working with the Local Editor.
Installs a code package to a site's repo.
If your site's repo has a yarn.lock file, the installer uses yarn to install packages by default. Otherwise, the installer uses npm by default. To specify which package manager to use, include an --npm or --yarn options flag.
Example install command:
Once the package is installed, a message is displayed in the terminal.
Updates a code package that's installed on a site's repo.
Uninstalls a code package from a site's repo.
Publishes a site.
You can choose to use either the code in the default branch of a site's repo or the local code on your computer as the publishing source.
Important: Publishing your local code leaves your live site and your site's GitHub repo out of sync. If you publish from the repo later without pushing your local code, your local code is overwritten and may be lost.
For more information, see Publishing a Site with the Git Integration & Wix CLI.
Builds a preview version of a site. You must first publish your site before running this command.
You can build the preview from the code in the default branch of a site's repo or from the local code on your computer.
Once the preview site is ready, a URL to the site is displayed in the terminal.
Note:
Logs in to a Wix account. This allows the CLI to perform actions on that account's sites.
When you run the command, the Wix login page opens in your default browser.
Displays the username of the currently logged in Wix user.
Logs out of a Wix account.