open-index/open-npm huggingface dataset:
npm package: @shopstop/shopstop-client-typescript
Description: A TypeScript API Client for the ShopStop API
Author: danbelden
Latest version: 0.0.10

# shopstop-client-typescript

[![CircleCI](https://circleci.com/gh/shopstop/shopstop-client-typescript.svg?style=svg&circle-token=9e711384dde961c3bcf65ea8586600d49f38727e)](https://circleci.com/gh/shopstop/shopstop-client-typescript)
[![npm version](https://badge.fury.io/js/%40shopstop%2Fshopstop-client-typescript.svg)](https://badge.fury.io/js/%40shopstop%2Fshopstop-client-typescript)

A Typescript API Client for the ShopStop API.

## Dependencies

- TypeScript
- TS Node
- ESLint
- DepCruiser
- Jest

## Commands

```
$ make
help                           Show this help message.
fmt                            Run project code formatting
test                           Run project tests
```
npm package: @shopsync/cli
Description: A lightweight CLI to help sync your Shopify customizations with the latest theme updates from Shopify, or other premium themes.
Author: Daniel Nordby
Latest version: 1.2.4

# Shopsync

A lightweight CLI tool intended to keep premium versioned Shopify themes in sync with updates, without losing, or overwriting theme, style, and functional customizations.

It is primarily intended to be used with **existing** stores, but future enhancements are in the roadmap to consider starting brand new builds using this as a starter.

## Dependencies

- `node` >= `v20.19.0`
- `npm` >= `v10.8.2`
- [Shopify CLI](https://shopify.dev/docs/api/shopify-cli)
- [theme-check](https://github.com/Shopify/theme-check)

## Installation

### Global Installation

```bash
npm i -g @shopsync/cli
```

### Local Installation

```bash
npm install @shopsync/cli
```

## Usage

### With Global Installation

```bash
shopsync init
shopsync connect mystore.myshopify.com 123456789
shopsync sync
```

### With Local Installation

#### Option 1: Using npx (Recommended)

```bash
npx shopsync init
npx shopsync connect mystore.myshopify.com 123456789
npx shopsync sync
```

#### Option 2: Direct execution (Manual setup)

Add this to your project's `package.json`:

```json
{
  "bin": {
    "shopsync": "./node_modules/.bin/shopsync"
  }
}
```

Then run `npm install` to create the symlink, and use:

```bash
shopsync init
shopsync connect mystore.myshopify.com 123456789
shopsync sync
```

## Commands

- `init [directory]` - Initialize shopsync directory
- `connect [store] [themeId]` - Connect to a Shopify store / theme
- `sync` - Sync custom changes to local Shopify theme

---

## Troubleshooting

If `shopsync connect [store] [themeId]` appears to hang, please ensure you are authenticated to Shopify in your terminal. To validate, you can try a command like `shopify theme pull`. If an error is thrown, you are not authenticated and the CLI will not surface commands to log in to Shopify. Please login before continuing.