# shopify-ftp-access

> FTP Proxy for Shopify

Latest version **3.0.28** (published 2022-12-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install shopify-ftp-access
pnpm add shopify-ftp-access
yarn add shopify-ftp-access
bun add shopify-ftp-access
```

Provides the command `shopify-ftp`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.0.28 |
| Published | 2022-12-18 |
| First published | 2022-06-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 9 |
| Unpacked size | 224.3 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Felix Tellmann |
| Maintainers | felixtellmann |
| Keywords | shopify, api, ftp, proxy, gateway |

## Links

- npm: https://www.npmjs.com/package/shopify-ftp-access
- Repository: https://github.com/FelixTellmann/shopify-ftp-access
- Homepage: https://github.com/FelixTellmann/shopify-ftp-access#readme
- Issues: https://github.com/FelixTellmann/shopify-ftp-access/issues
- npm.io page: https://npm.io/package/shopify-ftp-access

## Dependencies (9)

- [chalk](https://npm.io/package/chalk.md) 4.1.2
- [request](https://npm.io/package/request.md) ^2.47.0
- [fx-style](https://npm.io/package/fx-style.md) ^1.6.17
- [commander](https://npm.io/package/commander.md) ^2.5.0
- [stat-mode](https://npm.io/package/stat-mode.md) ^1.0.0
- [dateformat](https://npm.io/package/dateformat.md) ^1.0.7-1.2.3
- [typescript](https://npm.io/package/typescript.md) ^4.7.4
- [@types/node](https://npm.io/package/@types/node.md) ^18.0.0
- [shopify-typed-node-api](https://npm.io/package/shopify-typed-node-api.md) ^2.1.0

## Recent versions

- 3.0.28 (latest) — 2022-12-18
- 3.0.27 — 2022-11-25
- 3.0.26 — 2022-11-25
- 3.0.25 — 2022-11-25
- 3.0.24 — 2022-11-25
- 3.0.23 — 2022-11-25
- 3.0.22 — 2022-11-25
- 3.0.21 — 2022-10-13
- 3.0.20 — 2022-10-13
- 3.0.19 — 2022-10-13
- 3.0.18 — 2022-10-13
- 3.0.17 — 2022-10-13
- 3.0.16 — 2022-10-13
- 3.0.14 — 2022-07-18
- 3.0.13 — 2022-07-18
- … 18 more at https://npm.io/package/shopify-ftp-access/versions

## README

## Shopify FTP Proxy

This runs a local FTP server (on localhost) that will communicate with Shopify over HTTP API and allows you to upload/download/edit your theme files and assets using your favorite FTP client.

Note: this tool is built with [Node.js](https://nodejs.org) and is installed via [npm](https://www.npmjs.org) so make sure to have Node installed. I have tested this on Mac and Windows.

 
### Installation:

    npm install -g shopify-ftp2

Note: You may need to run as root/super-user on Mac/Linux using `sudo npm install -g shopify-ftp` or, alternatively, install without `-g` and then specify the full path to `shopify.js` in place of `shopify` each time you launch the program. The full path might look something like `/Users/You/node_modules/shopify-ftp/shopify.js` depending on where `npm` puts your module.

### Usage:

    shopify ftp

By default, it will listen on 127.0.0.1 at port 2121. The port and host can, optionally, be specified as follows:

    shopify ftp --port 2121 --host 127.0.0.1

Beginner note: The above commands should be entered at the command line (Terminal.app on Mac or Command Prompt on Windows)

### Get Shopify API Key(s)

You will need a Shopify API key-pair.

 * Go to: [{store-name}.myshopify.com/admin/apps](https://myshopify.com/admin/apps)
 * Click "Private Apps" in the top right corner
 * Click on an existing private app or create a new one
 * Copy the API key and Password

### Connecting over FTP

Open your favorite FTP client, for instance [FileZilla](https://filezilla-project.org/) and create a new connection with the following details:

 * Host: `127.0.0.1`
 * Port: `2121`
 * Username: `{api-key}@{store-name}`
 * Password: `{api-password}`

Then save/connect and you should be able to browse your assets and templates including upload, delete, rename, download and move. When you first connect, you should see a list of folders which corresponds to your different themes. Choose your theme and go into that directory. There you will see a few directories (assets, config, layout, snippets, templates). You can add/rename/delete files from these directories, but you will not be able to create/delete sub-directories due to limitations in place by Shopify. You must use the folder structure that exists.

Note: Your username contains __both__ your API key and your store name (separated by `@`).

Have fun.

---
_Source: https://npm.io/package/shopify-ftp-access · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._