The WMT Design Tool is a command line interface (CLI) to manage and synchronize WEM Design Templates.
At the moment, this tool is only available for MS Windows and Apple MacOS.
This tool allows you to connect to the WEM Design Template Server, get available design templates, create copies and upload changes.
To change the contents of Design Template (html, css, less) you can use the Visual Studio Code editor, that allows you to access the local copies of your Design Templates and provides a powerful tool to work with the files and make changes.
Download and run the WMT Design Tool Installer from the following location:
WINDOWS | MacOS |
---|---|
Following information is based on the Windows use.
For MacOS-users, please use the appropriate corresponding commands and syntax.
After installation, the wmt
command is available from the command prompt (or PowerShell):
The first time you run this command, it will ask for a few configuration settings:
Username - this should be the e-mail address that you use to login to the WEM Modeler.
Template path - the location where the design templates are stored locally. An example location could be C:\WEM Design Templates
or E:\Wem\DesignTemplates
as used in examples below.
These settings can always be changed by running wmt config set
:
Before working with the WMT tool, you need to login to the remote server:
It will prompt for a password. Use the same password that you use to login to the WEM modeler.
You can also explicitly logout of the server, using the wmt logout
command.
Use -? with any command to show help and usage information
To get access to already existing custom Design Templates / Collections through the WMT Tool, WEM Support needs to explicitly link your account to the Design Template Collections.
This is NOT necessary if you want to work with existing Global Templates as a base for new custom templates > read #create-a-new-design-template-from-a-source-template
Please create a Support Ticket in MyWEM, requesting access to specific Custom Design Template Collections, make sure you specifically indicate the Custom Design Templates you need access to.
A collection is used to group multiple Design Templates and can be linked to Workspaces, to make the Design Templates available in WEM Modeler Projects within those Workspaces. To make a certain Collection available to projects in your workspace, you need to use the share
command to create a token, then use that token in WEM Modeler > Manage Workspaces > Add Design Template Collection.
The list
, download
and create
commands can work from any current folder, because they use the root-folder from the configuration and fully-qualified Design Template Names ("Collection\Template") in case of download and create.
All other commands MUST be executed from within the local folder of a specific Design Template, so make sure you use the Change Directory (cd) command to set your CLI into the correct Template Folder.
To create a new Design Template, you always use an existing Design Template as source. A copy of all files and folders will be made with the new name.
The Names of the source and new Template should be like:
-n "Collection Name\Template Name" -s "Collection Name\Template Name".
The available Global Templates can be used as source for your own new custom Templates. To get a list of all available Global Templates, use wmt template list --global
:
After creating the new Design Template you need to download it in order to start editing the template locally. You need to have a local copy of the Design Template before you can push or pull changes.
To pull the latest version of a specific Design Template or push changes from your local folder to the WMT Server, you first need to set the current folder in your CLI tool.
The push
command updates the remote files with the local changes you made. This action will also perform a compile and control step to inform you of any faults that may be in the contents.
The push
command will NOT update the Design Template in the WEM Modeler - for that final step you need to execute the commit
command.
From within a local Design Template Folder, the WMT tool compares the local files to the server files and provides details on the files and lines which are different.
From within a local Design Template Folder, the commit
action performs the final step to make your changes available to the WEM Modeler for Preview, and for the publish process to Staging and Live.
When you use the autopush command in a specific local Design Template folder, it will automatically trigger the push command when a local file has been changed and saved.
This installer is only for Windows!
This App version is only for MacOS! It is a downloadable ZIP-file, containing the WMT (without extension) as a file to be extracted. File MUST remain without extension!
The publisher is not officially trusted by Windows so you will need to explicitly override the warning to allow download and installation of this file.
Make sure to add the file WMT
to your usr/local/bin
folder (or create one if it does not exist)
Use 'chmod +x WMT
' to make sure the file is executable.
Configure the template folder path without relative paths. For example '/Users/MyUser/Documents/Templates
'