Skip to content

Commit cbb14c5

Browse files
authored
Add installation instructions for Polaris CLI (#8457)
### WHY are these changes introduced? Polaris CLI isn't currently installed by default with the Shopify CLI. We need to add back the installation instructions for this CLI plugin. <!-- Context about the problem that’s being addressed. --> ### WHAT is this pull request doing? Add installation instructions on the Polaris CLI page. <img width="1488" alt="Screenshot 2023-02-22 at 1 57 49 PM" src="https://user-images.githubusercontent.com/11774595/220731423-1d9d6b73-fb1d-4e80-bc3e-77108dfa3d08.png">
1 parent 87fec52 commit cbb14c5

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

polaris.shopify.com/content/tools/polaris-cli.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,18 @@ keywords:
1111

1212
[<img src="https://img.shields.io/npm/v/@shopify/polaris-cli.svg?labelColor=f9f9f9&color=dcf5f0" alt="npm version" style="width: 95px" />](https://www.npmjs.com/package/@shopify/polaris-cli)
1313

14+
## Installation
15+
16+
You can install the Polaris plugin for the Shopify CLI by running the following command:
17+
18+
```sh
19+
shopify plugins install @shopify/polaris-cli
20+
```
21+
22+
See the [Shopify CLI command syntax](https://shopify.dev/apps/tools/cli/commands#command-syntax) section for how to execute commands using other package managers (ex: npm, Yarn, or pnpm).
23+
24+
## Commands
25+
1426
### migrate
1527

1628
Executes the [Polaris Migrator](/tools/polaris-migrator). This makes version upgrades faster and safer by performing codemod transformations to your codebase. You can apply any of the [available Polaris migrations](/tools/polaris-migrator#migrations) using the [Shopify CLI](https://shopify.dev/apps/tools/cli/commands) `migrate` command.

0 commit comments

Comments
 (0)