Shopify App CLI core commands

This reference lists the core commands that you can use with Shopify App CLI.

help

Lists the available commands and describes what they do. The commands available depend on whether you're inside a project directory, and whether your project uses Node.js or Ruby on Rails.

Terminal
$ shopify help
$ shopify -h
$ shopify --help

You can also use the help command or options to get more detailed information about a specific command:

Terminal
$ shopify help [command]
$ shopify [command] -h
$ shopify [command] --help

connect

Connects an existing Shopify App CLI project to a partner account or to a specific Shopify development store.

The connect command re-creates the project's .env and .shopify-cli.yml files if they don't exist, or updates the files if they do exist.

  • .env contains sensitive information that provides functionality to your app, such as the app key. As a result, this file shouldn't be saved to a version control system.
  • shopify-cli.yml contains insensitive information required for a project to work with Shopify App CLI, such as the project type.

This command is useful if you're working on one project across multiple computers, or if you're collaborating with other developers using a version control system like Git.

Terminal
$ shopify connect

create

Creates a new project of the specified type. The project is created in a subdirectory of the current directory:

Terminal
$ shopify create

When running the create command on its own, the CLI prompts you to choose a project type:

Terminal
$ shopify create
? What type of project would you like to create? (Choose with ↑ ↓ ⏎, filter with 'f')
> 1. Node.js App
  2. Ruby on Rails App

You can also specify the type of app you want to create using a subcommand:

  • For a Node.js app: node
  • For a Ruby on Rails app: rails

If you specify a type, then Shopify App CLI skips ahead and prompts you to enter a name for your project:

Terminal
$ shopify create node
? App Name
>

logout

Logs you out of the currently authenticated partner organization and store. The logout command clears credentials. You need to re-authenticate the next time you connect your project to Shopify.

Terminal
$ shopify logout

config

Configures Shopify App CLI options. There are two available options: analytics and feature.

analytics

Configures anonymous usage reporting by enabling or disabling analytics.

Terminal
$ shopify config analytics [ --status | --enable | --disable ]

feature

Configures active feature sets in the CLI.

This command is used for development and debugging work on the CLI tool itself. You shouldn't alter this if you're not developing the tool. Check the Shopify App CLI development guide for more information.

Terminal
$ shopify config feature [ feature_name ] [ --status | --enable | --disable ]

Next steps

Read complete reference documentation of the commands available inside different project types: