Stackbit CLI for Netlify Create

Configure and run Netlify Create locally.

Setup

Installation

It is recommended that you install Stackbit CLI for Netlify Create locally on your machine.

  • 1
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                Netlify Create 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:

  • 1
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 importing into production with Netlify Create. Learn more about local development.

  • 1
  • 2
cd my-stackbit-site
stackbit dev

telemetry-enable & telemetry-disable

Netlify Create contains a telemetry feature that collects anonymous information on the usage of Stackbit CLI for Netlify Create 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:

  • 1
  • 2
  • 3
  • 4
  • 5
# opt out of sharing usage information
stackbit telemetry-disable

# allow collecting your usage information
stackbit telemetry-enable