# shopify-cli-action

**Repository Path**: mirrors_Shopify/shopify-cli-action

## Basic Information

- **Project Name**: shopify-cli-action
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-12-18
- **Last Updated**: 2026-01-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<div align="center">
  <img src="assets/logo.png" width="150"/>
  <h1>Shopify CLI Action</h1>
</div>

This repository contains a [GitHub Action](https://github.com/features/actions) to use the Shopify CLI 2.x from CI pipelines.

## CLI Deprecation & Sunset

Note that Shopify CLI 2.0 is deprecated and will be sunset on May 31, 2023. We encourage using [Shopify CLI 3.0](https://github.com/Shopify/cli) to develop apps, custom storefronts, and themes.

Documentation about Shopify CLI 3.0 and CI/CD:
- https://shopify.dev/apps/tools/cli/ci-cd
- https://shopify.dev/themes/tools/cli/ci-cd

## Usage

Add a new step to your GitHub Actions workflow that uses `shopify/shopify-cli-action`.

```yaml
name: My project

on:
  push:
    branches:
      - main
  pull_request:

jobs:
  build:
    name: Build
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v1
      - uses: ruby/setup-ruby@v1
        with:
          ruby-version: 2.7.5
      - uses: shopify/shopify-cli-action@v1
        with:
          path: 'scripts/my_script'
          auth-token: ${{ secrets.SHOPIFY_CLI_AUTH_TOKEN }}
          command: 'script push'
```

**Note:** It's important that Ruby is installed through the `ruby/setup-ruby` action to prevent permission-related issues using the system Ruby.