Visual Editor CLI

Configure and run the visual editor locally.

Visual Editor is deprecated

Netlify Visual Editor is deprecated. The deprecation was announced on November 10, 2026, and Visual Editor will reach end of life on February 8, 2027, when it will no longer be available or supported.

If your team already has Visual Editor enabled, you can keep using it until February 8, 2027, and the docs in this section still apply to you until then. No new teams or projects can enable Visual Editor. For the full timeline and migration guidance, see the changelog announcement.

Setup#

Installation#

It is recommended that you install Visual Editor CLI locally on your machine.

npm install -g @stackbit/cli

This adds the stackbit command to your path. See below for usage instructions.

Usage#

To see a list of available commands use the --help flag:

1
2
3
4
5
6
7
8
9
10
11
12
13

stackbit --help

Usage:
  stackbit [command]

Commands:
  stackbit telemetry-enable   Enable telemetry
  stackbit telemetry-disable  Disable telemetry
  stackbit dev                Visual editor local development server

Options:
  --help     Show help                                                 [boolean]
  --version  Show version number                                       [boolean]

See below for a list of commands.

Direct Usage with `npx`#

Rather that installing globally, you can also use the CLI directly with npx:

npx @stackbit/cli [command]

Because the CLI package has a large number of dependencies, this is not recommended, as it will take much longer to run a command.

Commands#

`dev`#

Boot stackbit dev, our local development server, used for developing projects locally before creating a cloud project with visual editing. Learn more about local development.

cd my-stackbit-site
stackbit dev

`telemetry-enable` & `telemetry-disable`#

The visual editor contains a telemetry feature that collects anonymous information on the usage of Visual Editor CLI commands. We do this to improve the reliability of the CLI and help drive new features and improvements. Learn more about data collected via telemetry.

If you'd like to opt-out of sending usage information, you can do so by running the following command:

# opt out of sharing usage information
stackbit telemetry-disable

# allow collecting your usage information
stackbit telemetry-enable

GeezerVison