@peaknut/storeden-dev-cli
v1.0.9
Published
Storeden Development CLI
Downloads
25
Maintainers
Readme
Storeden Development CLI
CLI to deploy template on a Storeden instance.
How to Install
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
$ storeden-dev-cli \
--email '[email protected]' \
--password 'password1234' \
--storeID '123456' \
--themeName 'theme-essential-001' \
--sourcePath '.'
or
$ storeden-dev-cli \
-e '[email protected]' \
-p 'password1234' \
-s '12345678' \
-t 'theme-essential-001' \
-f '.'
Usage with config file
$ 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 protected]",
"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.