scs-commander
A library and CLI tool for interacting with the Shopware Community Store.
Last updated 4 months ago by viison .
MIT · Repository · Bugs · Original npm · Tarball
$ cnpm install scs-commander -g
SYNC missed versions from official npm registry.

scs-commander

Software License Build Status

A CLI tool for managing plugins in the Shopware Community Store.

Install

For now you have to pull this repository or download the source and install it using npm install && npm link.

Configuration

You can set your Shopware Community Store username and password in an environment configuration in your user's home directory (~/.scs-commander). This file is optional, so you can still pass the username via -u to each command and enter your password when asked. Also, even if ~/.scs-commander exists and contains a username, you can overwrite it by passing the '-u' argument to the command. Additionally you can set an optional HTTP webhook endpoint in the configuration file as well. This will call the endpoint upon a successful release. The URL supports basic auth and might look like this: https://USERNAME:PASSWORD@domain.tld/endpoint

See .scs-commander.dist for further info.

Usage

List all available plugins

scs-commander list -u <your_username>

You can sort the results by passing option -s <sort_field>. The available sort fields are name, version, active, reviewStatus and shopwareCompatibility. By default only active plugins are listed. If you wish to list all plugins of the account pass --show-all.

Update the description of a plugin

scs-commander description -u <your_username> -p <technical_plugin_name> -l <locale> <path_to_description_file>

Upload a new version of a plugin

Remark: You can only upload plugin .zip files, which contain a valid plugin.json file next to the plugin Bootstrap.php (see shopwareLabs/plugin-info for more info).

scs-commander upload -u <your_username> <path_to_plugin_zip_file>

By default, this command automatically requests a review of the uploaded plugin version, which causes the binary to be released automatically. If you only want to upload the binary, pass the --no_release or -R option. If set, the HTTP endpoint will get called after a successful release.

Hint: Releasing the plugin right away makes usually only sense when providing a changelog for all available languages. The changelog is parsed either directly from plugin.json or, if available in the provided .zip file, from CHANGELOG.md. The benefit of using a separate CHANGELOG.md file is the readability. Currently the changelog parser supports only a simple structure:

## <version_0>

### <language_A, e.g. 'de'>

The changelog content of 'version_0' in 'language_A'. Can contain any markdown except for '##' and '###' headlines.

### <language_B, e.g. 'en'>

The changelog content of 'version_0' in 'language_B'.

## <version_1>

### <language_A, e.g. 'de'>

The changelog content of 'version_1' in 'language_A'.

[...]

Any whitespace/newlines leading or trailing a changelog for a version/language is trimmed and the remaining content is compiled to HTML, which is used as the changelog in the store. This makes it easy to add lists, links and simple formatting (bold, italic etc.) to your plugin changelogs in the community store (and it looks nice in your GitHub repositories too). The order of versions or languages within a version is arbitrary.

Print the changelog of a plugin

scs-commander changelog -l <language, e.g. "en"> <path_to_plugin_zip_file>

You can also get complied HTML (which is the same as used by the upload command) by setting --html. If no language is provided, the english changelog is returned.

License

MIT

Maintainers (1)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 0
Dependencies (15)
Dev Dependencies (4)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |