Shopify CLI core commands
This reference lists the core commands that you can use with Shopify CLI.
help
Lists the available commands and describes what they do.
You can also use the help command or options to get more detailed information about a specific command:
login
Authenticates you with Shopify CLI.
Optional parameters
| Parameter | Description |
|---|---|
--store <DOMAIN> |
The store that you want to log in to. This is used when developing a theme. To learn more about this parameter, refer to the login command for themes. |
logout
Logs you out of the Shopify account or Partner account and store.
The logout command clears credentials. You need to reauthenticate the next time that you connect to a store.
populate
Adds example data to your store for testing your app or theme’s behavior.
The populate command lets you specify which type of data you're populating, and how many to create:
| Parameter | Description |
|---|---|
products |
Creates products in your store. Products are created with a title and a price. |
customers |
Creates customers in your store. Customers are created with a name only. |
draftorders |
Creates draft orders in your store. Draft orders are created with one custom item. |
--count <NUMBER> |
Creates the specified number of records. This is an optional parameter. If no count is specified, then five records are created. |
store
Displays the store that you're currently connected to.
Example output:
switch
Switches between stores without logging out and logging in again.
If you enter this command without a --store flag, then you're prompted to select a store associated with your account.
The --store flag accepts the following inputs:
| Type | Example |
|---|---|
| The store prefix | johns-apparel |
| The myshopify.com URL | johns-apparel.myshopify.comhttps://johns-apparel.myshopify.com |
| The store admin URL | https://johns-apparel.myshopify.com/admin |
| The custom domain or custom domain admin | https://johnsapparel.comhttps://johnsapparel.com/admin |
version
Displays the version of Shopify CLI that you're running.
Example output:
config
Configures Shopify CLI options. There are two available options: analytics and feature.
analytics
Configures anonymous usage reporting by enabling or disabling analytics.
feature
Configures active feature sets in the CLI.
This command is used for development and debugging work on the CLI tool itself. Unless you're developing the tool, don't alter this command. Review the Shopify CLI development guide for more information.
whoami
Determines which Partner organization you're logged in to, or which store you're logged in to as a staff member.
Example output:
Next steps
Read the complete reference documentation for app commands.