# @peaknut/storeden-dev-cli

> Storeden Development CLI

Latest version **1.0.9** (published 2020-12-15) · ISC license · 0 weekly downloads

## Install

```sh
npm install @peaknut/storeden-dev-cli
pnpm add @peaknut/storeden-dev-cli
yarn add @peaknut/storeden-dev-cli
bun add @peaknut/storeden-dev-cli
```

Provides the command `storeden-dev-cli`.

## 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 | 1.0.9 |
| Published | 2020-12-15 |
| First published | 2020-12-01 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 13 |
| Unpacked size | 11.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | peaknut |
| Maintainers | peaknut |
| Keywords | cli, storeden, development, theme, template |

## Links

- npm: https://www.npmjs.com/package/@peaknut/storeden-dev-cli
- Repository: https://github.com/francescolaruffa/storeden-dev-cli
- Homepage: https://github.com/francescolaruffa/storeden-dev-cli#readme
- Issues: https://github.com/francescolaruffa/storeden-dev-cli/issues
- npm.io page: https://npm.io/package/@peaknut/storeden-dev-cli

## Dependencies (13)

- [got](https://npm.io/package/got.md) ^11.8.0
- [md5](https://npm.io/package/md5.md) ^2.3.0
- [ora](https://npm.io/package/ora.md) ^5.1.0
- [chalk](https://npm.io/package/chalk.md) ^4.1.0
- [clear](https://npm.io/package/clear.md) ^0.1.0
- [yargs](https://npm.io/package/yargs.md) ^16.1.1
- [cheerio](https://npm.io/package/cheerio.md) ^1.0.0-rc.3
- [fs-extra](https://npm.io/package/fs-extra.md) ^9.0.1
- [form-data](https://npm.io/package/form-data.md) ^3.0.0
- [tough-cookie](https://npm.io/package/tough-cookie.md) ^4.0.0
- [child_process](https://npm.io/package/child_process.md) ^1.0.2
- [readline-sync](https://npm.io/package/readline-sync.md) ^1.4.10
- [lodash.debounce](https://npm.io/package/lodash.debounce.md) ^4.0.8

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 1.0.9 (latest) — 2020-12-15
- 1.0.8 — 2020-12-04
- 1.0.7 — 2020-12-03
- 1.0.6 — 2020-12-03
- 1.0.5 — 2020-12-02
- 1.0.4 — 2020-12-01
- 1.0.3 — 2020-12-01
- 1.0.2 — 2020-12-01

## README

# Storeden Development CLI

CLI to deploy template on a Storeden instance.

## How to Install

```bash
npm install -g @peaknut/storeden-dev-cli
```

## How to Use

```
Usage: storeden-dev-cli [options]

Options:
  -e, --email       Your Storeden Store account's email                 [string]
  -p, --password    Your Storeden Store account's password              [string]
  -s, --storeID     Your Storeden Store ID                              [number]
  -t, --themeName   Your Theme name used in Storeden Store              [string]
  -d, --diffCmd     Your prefered diff Command (vscode, diff, opendiff) [string]
  -f, --sourcePath  Path to template folder                             [string]
  -j, --json        JSON config path                                    [string]
      --help        Show help                                          [boolean]
      --version     Show version number                                [boolean]

Examples:
  index -e "" -p "" -s "" -t "" -f "."  Start in command line mode
  index --json "./config.json"          Use config file
```
### Usage with command line params

```bash
$ storeden-dev-cli \
  --email 'email@email.com' \
  --password 'password1234' \
  --storeID '123456' \
  --themeName 'theme-essential-001' \
  --sourcePath '.'
```
or

```bash
$ storeden-dev-cli \
  -e 'email@email.com' \
  -p 'password1234' \
  -s '12345678' \
  -t 'theme-essential-001' \
  -f '.'
```
### Usage with config file

```bash
$ storeden-dev-cli -j './config.json'
```
Config file has to contain all the params that you can specify in the command line and has to contain a valid json object.

Here an example of config object:

```
{
  "username": "email@email.com",
  "password": "password1234",
  "storeID": "12345678",
  "themeName": "theme-essential-001",
  "sourcePath": ".",
  "diffCmd": "vscode"
}
```
## Hints
As diff tool you can choose one of these:
- vscode: if you use vscode as IDE,
- opendiff: if you prefer the UI version on OSX

## Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

## License

MIT.

---
_Source: https://npm.io/package/@peaknut/storeden-dev-cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._