Recommended developer workflow - plugins

This article describes the recommended developer workflow for plugins.

Recommended developer workflow

Make changes directly in your generated plugin repository/folder.

Add an app key - First-time upload

Get your app key

The app key is required for uploading plugins.

Install the dev tools:

npm i -g git+

This will create a config.json file in your /.tymlez folder.

To upload generated plugins using the CLI, the appropriate app key must be added to the config.json file, found in your home directory, ~<home>/.tymlez, and was generated when you installed the development tools.

Obtain your app key by logging into the UI as admin and

  • navigate to the top right corner and click App keys.
  • click Add key to create a key.
  • select ng-rt-admin and domain A.

After creating the key, copy and paste the app key for ng-rt-admin into the config.json of your home/.tymlez folder in the following format:

"env": {
"default": "local",
"local": {
"serverType": "http",
"serverUrl": "<Server URL>",
"bigchaindbUrl": "",
"keypair": {
"private": "<YOUR_PRIVATE_KEY_HERE>"
"storage": "main",
"appKeys": [
"appName": "ng-rt-admin",

Upload your plugin via CLI 

To upload these new changes, run the following two commands to generate the distribution file and upload it to the server.

If you are uploading to your server for the first time, you need an app key in your plugin settings, explained above.

npx tymlez-dev gulp dist
npx tymlez-dev plugin upload
  • For even quicker upload for your changes, add this alias to your bash_profile.
alias up=npx tymlez-dev gulp dist; npx tymlez-dev plugin upload
  • For a quick removal of uploaded plugins, add this alias to your bash_profile.
alias remove='npx tymlez-dev plugin remove'
  • To replace an existing plugin, add this alias to your bash_profile.
alias update='remove;up'

Upload the zip file via the UI

Log in to your instance as administrator:

In the menu bar, select *Plugins*.

Click on 'Add plugin' at the top right corner.

Click on the folder icon and then select the zip file that you created in the previous steps. In this step, select a storage option.Click 'Upload' and monitor the upload progress.

After the plugin has been uploaded, select the 'Custom Plugins' tab to see the uploaded plugin.

Install the plugin via UI

Click on the desired plugin.

A plugin management window will open. Click *Install*.

When prompted for permissions, click *Accept*.

In the settings prompt, keep the current settings.

After you click *Accept*, the plugin installation begins.

Once installation is complete, a checkbox will appear next to the plugin.

Click the checkbox, and the activation message below appears.

The plugin is now activated and is ready for use.

Use the plugin

Log in with admin.

If the plugin was installed successfully, you will see the plugin displayed in the plugins section on the left.

Congratulations! Your first plugin is now working!