CLI commands to help with developing with Argo

Usage no npm install needed!

<script type="module">
  import shopifyArgoAdminCli from 'https://cdn.skypack.dev/@shopify/argo-admin-cli';


Argo Admin CLI

The Argo Admin CLI allows you to build and preview Argo Admin Extensions. This tool is intended to help partners test Argo Extensions before publishing to Shopify. It comes packaged with Shopify CLI, so when you create an extension using Shopify CLI's shopify create extension command, your project will automatically consume this package.

Start using this tool in one of two ways:

  1. Create an extension with Shopify CLI
    Shopify CLI clones argo-admin-template repo, which consumes this package to build and serve Argo Extensions it generates
  2. Manually clone the argo-admin-template
    Bypass Shopify CLI and follow the set up steps in the README from argo-admin-template

How to use

When consumed in a project, the command argo-admin-cli becomes available to the project. The command can be used to build and serve Argo Admin Extensions.

To use this package in an Argo Extension project, run:

npm install @shopify/argo-admin-cli


yarn add @shopify/argo-admin-cli

See usage details in the API docs.

Local development of this tool

To make and preview changes from ./src, run a local server from this project using:

yarn server