eWizard CLI commands

eWizard CLI provides a CLI interface for simplifying content creation and working with eWizard platform. With the use of some simple CLI commands you can initialize the eDetailer, export it to appropriate CLM, push to eWizard platform or implement appropriate functionality.

eWizard CLI commands could be divided into a few groups depending on their purpose:

  • Authentification
  • Scaffolding
  • Development
  • Export

Authentification commands

These commands will help you to log in and logout from the platform. Since eWizard platform and eWizard CLI are strongly connected, you can log in through CLI and then proceed working in eWizard platform without any extra efforts for log in.

$ wiz login [options]
ParametersExplanation
-i, --instance <instance>specifies an instance to which you will be logged in
-u, --user <user>specifies a login for authentification
-p, --password <password>specifies a password
-h, --helpoutputs information about the command and available parameters

This command is dedicated for login to the system. As a result, after executing this command eWizard's Login page will be opened in your default browser while the console is switched to the waiting mode. In case it is not possible to open a browser from the console, you need to do it manually - an appropriate URL will be outputted in the console. After successful login, you can close a browser and continue working with eWizard CLI.


$ wiz logout

This command does not have any additional parameters.

This command is dedicated for log out of the system. The next time, when you will try to perform any operations, you will be warned that you are not logged in.

eDetailing development commands

The following commands are dedicated to ease the actual development of any eDetailing content (e-mails, presentations, survey, etc). They provide possibilities for automation content creation.


$ wiz init
ParametersExplanation
-h, --helpoutputs information about the command and available parameters

This command will initialize the structure for some eDetailer. After running the command, you will be prompted about some project settings like type, description, name, etc. When the command will be executed, you will be able to check the initial structure of your eDetailer.


$ wiz dev
ParametersExplanation
-w, --watchwill continuously build presentation source files, so after making changes in IDE, they will be instantly reflected in the browser

This command will run a develop build, so you will be able to check how the project is looking in the browser.


$ wiz install <component-name>
ParametersExplanation
-h, --helpoutputs information about the command and available parameters

This command will install eWizard component into your eDetailer, so you will be able to add it on the markup or use component API if any exists.


$ wiz slide <slideId>
ParametersExplanation
--chapter <chapterID>specifies the chapterID to which slide should be added

This command will create a slide with specified slideID. All additional .html, .css will be also created.


$ wiz config
ParametersExplanation
-w, --ewizard <eWizard>set eWizard authorization server, by default starts with https://
-r, --reset [key]reset configuration
-h, --help <eWizard>outputs information about the command and available parameters

This command will help you to change some of your account configurations.


$ wiz archive

This command does not have any additional parameters. It will create a zip-archive of your eDetailer.