Shopify App CLI command reference (Node.js)
This reference lists the Node.js commands that you can use with Shopify App CLI.
deploy
Deploys the current Node.js app to a hosting service. Currently, the only option is Heroku.
$ shopify deploy heroku
open
Opens your local development app in your default browser.
$ shopify open
populate
Adds example data to your development store. This is useful for testing your app’s behavior. You can create the following types of example store records:
- Products
- Customers
- Draft orders
$ shopify populate products
$ shopify populate customers
$ shopify populate draftorders
By default, the populate
command adds 5 records. Use the --count
option to specify a different number:
$ shopify populate products --count 10
serve
Starts a local development server for your project and a public ngrok tunnel to your localhost.
$ shopify serve
tunnel
Controls an HTTP tunnel to your local development app using ngrok. With the tunnel
command, you can authenticate with ngrok and start or stop the tunnel.
To authenticate with ngrok, you need an authentication token. You can find it in your ngrok dashboard. Copy your token and use it with the tunnel auth
command:
$ shopify tunnel auth <token>
This writes your ngrok auth token to ~/.ngrok2/ngrok.yml
. To learn more about ngrok configuration, refer to ngrok’s documentation.
To start an ngrok tunnel to your app in your localhost development environment:
$ shopify tunnel start
To stop the running ngrok tunnel:
$ shopify tunnel stop
Next steps
- Learn how to create and manage different types of projects with Shopify App CLI.
- Familiarize yourself with the core commands for Shopify App CLI.