@shopify/plugin-polaris

Polaris CLI

Shopify CLI plugin for managing Shopify Apps using Polaris.

Installation

You can install the Polaris plugin using the Shopify CLI by running the following command:

shopify plugins install polaris

Note: run the shopify CLI using the following syntax based on your package manager (ex: npm, Yarn, or pnpm).

Commands

This reference lists the Shopify CLI commands for Polaris.

migrate

Codemod transformations to help upgrade your Polaris codebase.

shopify polaris migrate <migration> <path>

• migration - name of migration, see available migrations on the docs site below.
• path - files or directory to perform migration

Flags

Flag	Description
--dry	Do a dry-run, no code will be edited
--print	Prints the changed output for comparison
--force	Bypass Git safety checks and forcibly run migrations