########::::'###::::'########::'########::'####:'########:'########::'######::'########:
  ..... ##::::'## ##::: ##.... ##: ##.... ##:. ##:: ##.....:: ##.....::'##... ##:... ##..::
  :::: ##::::'##:. ##:: ##:::: ##: ##:::: ##:: ##:: ##::::::: ##::::::: ##:::..::::: ##::::
  ::: ##::::'##:::. ##: ########:: ########::: ##:: ######::: ######:::. ######::::: ##::::
  :: ##::::: #########: ##.....::: ##.....:::: ##:: ##...:::: ##...:::::..... ##:::: ##::::
  : ##:::::: ##.... ##: ##:::::::: ##::::::::: ##:: ##::::::: ##:::::::'##::: ##:::: ##::::
   ########: ##:::: ##: ##:::::::: ##::::::::'####: ##::::::: ########:. ######::::: ##::::
  ........::..:::::..::..:::::::::..:::::::::....::..::::::::........:::......::::::..:::::

Cli app to generate and publish Zapp plugin manifest.

Installation

Install via Homebrew

brew tap applicaster/tap
brew install zappifest

Upgrade

brew upgrade zappifest

Usage

Init

Zappifest allows fast configuration for Zapp plugin-manifest.json file. Just run zappifest init and follow the instructions.

Publish

Prerequisites

Reach Applicaster support team to generate User access-token.

The tool allow you to publish the plugin to Zapp.

Run zappifest publish <path-to-manifest-json-file> --access-token <zapp-access-token> --account <account-id>

Note: path to manifest has to be a first param after the publish command, as you can see above.

If you want to publish a manifest for a new plugin, with a new identifier, you need to use the --new option. This isn't needed when you are publishing a new version or updating an existing version of an existing plugin.

Every plugin belong to account. A user can’t update a plugin if the user is not a plugin_developer of the plugin’s account.

Note: It is recommended to set the access-token as environment variable `ZAPP_TOKEN`.
By doing so, `access_token` param for publishing will not be required.

Updating existing plugin

Check the plugin id on Zapp (under the relevant plugin versions).

Run zappifest publish <path-to-manifest-json-file> --plugin-id <plugin-id> --access-token <zapp-access-token> --account <account-id>

List account's associated plugins

In order to know on which plugins you can touch when you execute zappifest then you can see the list of an account’s associated plugins

Run zappifest get_account_plugins --access-token <zapp-access-token> --account <account-id>

List user's permitted accounts

In order to get the list of User's permitted accounts names and ids run the following command:

Run zappifest show_accounts --access-token <zapp-access-token>

Markdown files

You can use markdown files to populate the guide and description fields of the manifest. To do so, create markdown files for these fields, and add the path to these files in the command :

$ zappifest publish --manifest <path-to-manifest-json-file> --access-token <zapp-access-token> --plugin-about <path-to-about.md>

Overriding endpoints

When working vs local or stage server(s), it is imperative to override the url for the Zapp and accounts servers:

• Zapp server override: --base-url http://localhost:{your-port}/api/v1/admin
• Accounts server override: --accounts-url http://accounts.test/api/v1 Example for updating a plugin locally, given a zapp server up and running on localhost:4000 and an accout server running via pow:

ruby lib/zappifest.rb publish <path-to-manifest-json-file> --plugin-id 1234  --access-token <local-zapp-access-token> --base-url http://localhost:4000/api/v1/admin --accounts-url http://accounts.test/api/v1

Contributing

1. git clone https://github.com/applicaster/zappifest.git
2. cd zappifest
3. bundle exec bundle install
4. git checkout -b <your-branch>
5. Publish with your local changes ruby lib/zappifest.rb publish ....
6. Push branch to remote
7. Create PR