Development in eWizard CLI | Viseven Help Center

With the commands from this article, you can develop your items locally in the following ways:

• Run a development build and watch the changes in the browser as you update the project

• Install components and dependencies

• Add slides, subslides, or chapters to your e-Detailer

• Generate thumbnails for slides

• Archive your project for further uploading to the eWizard platform

• Generate screenshots for the email preview and block icons

• View the eWizard.js and eWizard CLI documentation

wiz dev [options]

Use the wiz dev command to run a development build. When your project is built locally, you can view it in the browser. The wiz dev command has the following options:

Options	Description
`--live`	Tracks the changes and continuously builds the project using http://localhost:3000/ for live reloading. The default port for the localhost is 3000. For example, run `wiz dev --live` in your project root directory. Make any changes in the slide .vue file. The http://localhost:3000/page reloads automatically and shows your changes.
`--watch`	Tracks the changes and continuously builds the project without the live reloading. When you run `wiz dev --watch`, refresh the browser page with your project homepage to see the changes. For example, open the `index.html` page in the root of your project in the browser. Make the changes in the slide .vue file. Refresh the browser page to see the changes.
`--fix`	If you select to use ESLint for linting your code when you initialize your project, this command builds the project and fixes it according to ESLint guideline. For example, run `wiz dev --fix` in your project root.
`--debug`	Builds the project with the source mapping. For example, run `wiz dev --debug`.
`--no-template`	Builds the project without the `./build/dev/templates.js` file. For example, run `wiz dev --no-template`.
`--from [LAYOUT_OR_WORKSPACE_NAME]`	Builds the email project with a specified layout or :Workspace:workspace:. You can build one layout at a time or multiple workspaces at the same time. For example, run `wiz dev --from my_name` to build your email with the specified layout or workspace: specific blocks, etc. The command archives the layout from the directory defined in the `layouts` field in system settings. The workspace directory must contain the email template. For more information, see Multiple layouts in one email template and Monorepo emails.
`--from-all`	Builds the email project with all :Workspace:workspaces:. For example, `wiz dev --from-all`.
`--validate`	Validates the HTML content in the `<i18n>` localization tags with HTML-validate. For example, `wiz dev --validate`.
`-h, --help`	Shows help for the `wiz dev` command and options. For example, `wiz dev -h`.

NOTE: In monorepo emails you can only use the --from and --from-all options.

wiz install [options]

Use the wiz install or wiz i command to install the components as dependencies in the package.json file of your project. You can install the component either from CodeArtifact or from GitLab.

eWizard CLI installs the node modules for the specified components to the ./node_modules/@[SCOPE] subdirectory. For example, the wiz-card component for e-Detailers is installed in the ./node_modules/@edetailer subdirectory.

The item type defines which components are installed. See the list of the eWizard.js components for e-Detailers, emails, or sites.

• To install a component from CodeArtifact, run:

wiz install @[SCOPE]/[COMPONENT_NAME]

— [SCOPE] is the CodeArtifact scope of your project. For example, the eWizard.js global CodeArtifact repository uses the item types as the scope: edetailer, email, and site.

— [COMPONENT_NAME] is the name of the component in the eWizard.js repository, such as wiz-accordion.

For example, to install the e-Detailer wiz-accordion component from a CodeArtifact repository, run:

wiz install @edetailer/wiz-accordion

NOTE: By default, the wiz install command installs components from a repository of the instance you are logged in to, for example, Viseven. If you want to install components from the global repository, use the .wizrc configuration file, or the hidden -r global option. For more information, see Install a component from the global CodeArtifact repository.

As a result, the following dependency is created in the package.json file of the project:

// package.json{
"dependencies": {
"@edetailer/wiz-accordion": "^3.0.0",
}
}

• To install a component from GitLab, run:

wiz install git+[COMPONENT_LINK]

COMPONENT_LINK is the cloned HTTPS link to the component repository on GitLab.

For example, to install the e-Detailer wiz-card component, run:

wiz install git+https://git.qapint.com/ewizardjs/edetailer/components/wiz-card.git

As a result, the following dependency is created in the package.json file of the project:

// package.json{
"dependencies": {
"@edetailer/wiz-card": "git+https://git.qapint.com/ewizardjs/edetailer/components/wiz-card.git",
}
}

For more information, see Install components.

The wiz install command has the following options:

Options	Description
`-h, --help`	Shows help for the `wiz install` command and options. For example, `wiz install -h`.

wiz publish [options]

Use the wiz publish command to publish a component to the private or global CodeArtifact repository.

You can publish to:

• the global repository from any instance if you have access to the Admin panel

• a private repository of the instance you are logged in

For example, if you are logged in to the Viseven instance, you can publish to the Viseven private repository or the global repository.

To publish components to a private repository, run:

wiz publish

To publish components to the global repository, run:

wiz publish --repository global

wiz publish -r global

The wiz publish command has the following options:

Options	Description
`-r global, --repository global`	Allows you to publish the components to the global CodeArtifact repository. For example, `wiz publish -r global`.
`-h, --help`	Shows help for the `wiz publish` command and options. For example, `wiz publish -h`.

wiz uninstall [options]

Use the wiz uninstall or wiz rm command to remove packages from the ./node_modules directory of your project. The command affects all packages with dependencies in the package.json file: blocks, components, and the eWizard.js dependency.

To remove a dependency, run:

wiz rm [DEPENDENCY_NAMES]

wiz uninstall [DEPENDENCY_NAMES]

[DEPENDENCY_NAMES] are the names of the dependencies in package.json.

For example, to remove the @blocks/module-placeholder block and the @edetailer/wiz-text component, run:

wiz rm @blocks/module-placeholder @edetailer/wiz-text

The wiz uninstall command has the following options:

Options	Description
`-h, --help`	Shows help for the `wiz uninstall` command and options. For example, `wiz uninstall -h`.

wiz slide [options]

To add a slide to your e-Detailer project:

wiz slide [SLIDE_ID]

SLIDE_ID is a unique slide ID in the slides object of the structure.json file. For more information, see e-Detailer structure.

Options	Description
`-c, --chapter [CHAPTER_ID]`	Adds your slide to the specified chapter where `CHAPTER_ID` is the ID of the chapter in the structure.json file. For example, run `wiz slide new --chapter default` to add the `new` slide to the `default` chapter in the `./structure.json` file. This command also adds the `./slides/new` directory to your e-Detailer project.
`-d, --delete [SLIDE_ID]`	Deletes the specified slide from your e-Detailer project. For example, run `wiz slide -d new` to delete the `new` slide in the `structure.json` file. This command also deletes the `./slides/new` directory.
`-h, --help`	Shows help for the `wiz slide` command and options. For example, `wiz slide -h`.

wiz subslide [options]

To add a subslide to the specific slide in your e-Detailer project:

wiz subslide [SUBSLIDE_ID] -s [SLIDE_ID]

SUBSLIDE_ID is a unique subslide ID and SLIDE_ID is the slide ID in the structure.json file. For more information, see Subslides.

Options	Description
`-s, --slide [SLIDE_ID]`	Adds your subslide to the specified slide where `SLIDE_ID` is the ID of the slide to which you add your subslide. For example, run `wiz subslide my_subslide -s new` to add the `my_subslide` subslide to the `new` slide in the `./structure.json` file. This command also adds the `./slides/my_slide` directory to your e-Detailer project. This command also adds the `my_subslide` slide to the `structure.json` file.
`-h, --help`	Shows help for the `wiz subslide` command and options. For example, `wiz slide -h`.

wiz chapter [options]

To add a chapter to your e-Detailer:

wiz chapter [CHAPTER_ID]

CHAPTER_ID is a unique chapter ID in the structure.json file. For more information, see Chapters.

For example, run wiz chapter new to add the new chapter in the structure.json file. This command also adds the new chapter to the storyboard.

Options	Description
`-h, --help`	Shows help for the `wiz chapter` command. For example, `wiz chapter -h`.

wiz [options]

Use the wiz command with options to find out the current version of eWizard CLI and to display the help for all the commands available for eWizard CLI.

Options	Description
`-V, --version`	Displays the current version of your eWizard CLI. For example, run `wiz -V`.
`wiz`	Shows help for all the commands available for eWizard CLI. The same as `wiz -h` or `wiz --help`.
`-h, --help`	Shows help for all the commands available for eWizard CLI. For example, `wiz -h`.

wiz component build [options]

Use the wiz component build command in the component project root directory to run a development build of a component.

eWizard CLI checks for errors in the tag markup in the <template> and <script> tags. After running the wiz component build command, the errors are displayed in the command line tool. In case of no errors, the build is successful.

The resulting build is created in the dist/build.js file.

Options	Description
`--name [COMPONENT_NAME]`	Updates the build name in the `dist/build.js` file. For example, run `wiz component build --name my_component` to set the current build name to `my_component`.
`-h, --help`	Shows help for the `wiz component build` command and options. For example, `wiz component build -h`.

wiz archive [options]

Use the wiz archive command in the project root to run the development build and create a ZIP archive of your project. You can upload the zipped project to the eWizard platform.

To exclude certain files from the development build, add the ignore object to the ./.ewizard/settings.json file. For example, to ignore all PNG files:

// ./.ewizard/settings.json
{
"archive": {
"ignore": ["-.png"]
}
}

You can ignore specific files, all files that have the specified extension, or directories. To ignore a directory in your project:

// ./.ewizard/settings.json
{
"archive": {
"ignore": ["test/"] // When you run wiz archive, the test directory is excluded from the build.
}
}

Options	Description
`--name [ARCHIVE_NAME]`	Generates the archive with the specified name. For example, run `wiz archive --name my_project` to generate the `my_project.zip` project archive. You can use the `--name` option only for one archive. Change the project name in the `./settings.json` file, which has the same result: the project name changes when you generate the build with `wiz archive`.
`--target [TARGET_CLM]`	Adds configuration for the specified target system to the `./settings.json` file in the zipped email project. For example, run `wiz archive --target viseven`. This command adds the `targetCLM` field that has the `viseven` value for `code` and `Viseven` for `name` in the `settings.json` file of your archived email project. See the list of target systems with codes.
`--theme [THEME_NAME]`	Generates the email project archive with the specified theme name. For example, run `wiz archive --theme viseven`. This command adds `viseven` as the `current` theme in the `./settings.json` file of the zipped project. This command also adds the `./themes` directory in your project.
`--scheme [SCHEME_NAME]`	Generates the email project archive with the specified scheme name. For example, run `wiz archive --scheme viseven`. This command adds the `viseven` value for the `scheme` field in the `theme` object of the `./settings.json` file of the zipped project. The `scheme` field isn't used at the moment.
`--from [WORKSPACE_NAME]`	Builds the email project with the specified :Workspace:workspaces:. For example, run `wiz archive --from my_workspace` to build your email with the specified workspace: specific blocks, etc. The specified workspace directory must be in the `emails` directory of your monorepo. The specified workspace directory must contain the email template. For more information, see Monorepo emails.
`--from-all`	Builds the email project with all layouts or :Workspace:workspaces:. For example, `wiz archive --from-all`.
`-h, --help`	Shows help for the `wiz archive` command and options. For example, `wiz archive -h`.

TIP: To use the --from option for multiple layouts with the same name, write the layout option with the parent directory. For example, to archive the layout1 layout from the Global directory:

wiz archive --from Global/layout1

wiz thumbs [options]

Use the wiz thumbs command to generate thumbnails for all the slides in your e-Detailer.

TIP: The wiz thumbs command doesn't generate thumbnails for archived slides and slides that aren't added to the chapter.

When you run this command for the first time, eWizard CLI installs the ewizardjs-screenshoter npm module. This module is required for generating screenshots. eWizard.js stores the generated thumbnail screenshot of each slide in this slide directory. For example, ./slides/slide1/media/images/thumb.jpg.

Options	Description
`-s, --slides [SLIDE_ID]`	Generates the thumbnail for the specified slide. For example, run `wiz thumbs -s default` to generate the thumbnail for the `default` slide in your e-Detailer. eWizard CLI adds the `thumb.jpg` thumbnail to the `./slides/default/media/images/` directory for the specified slide. The default thumbnail has the size of 1.2 KB. All other slides thumbnails have the size of 600 bites.
`-d, --delay [DELAY_IN_MS]`	Generates the thumbnails with the specified delay in milliseconds. For example, run `wiz thumbs -d 1000` to have a 1000 ms delay before generating the screenshot of your slides.
`-h, --help`	Shows help for the `wiz thumbs` command and options. For example, `wiz thumbs -h`.

To ensure the thumbnail includes all changes to the e-Detailer, run a development build before running wiz thumbs. If the development build doesn't exist in the project, eWizard.js runs the wiz dev command automatically.

wiz screen preview

To generate a preview screenshot of your email:

wiz screen preview

This command creates the preview.jpg file in the root of your email project.

To ensure the preview includes all changes to the email, run a development build before running wiz screen preview. If the development build doesn't exist in the project, eWizard.js runs the wiz dev command automatically.

To view help for the command, run wiz screen preview --help.

wiz screen block [options]

To generate the icon screenshots for the blocks in your email:

wiz screen block

This command generates the icon.png screenshot files for each block in your email project. The icon PNG file is a screenshot of the email block. When you run the command, eWizard CLI displays the messages indicating the path to the generated icons. The location of the generated icons is configured in the blocks field of the ./.ewizard/settings.json file. Each block directory contains the generated icon.

To ensure icon.png includes all changes to the email, run a development build before running wiz screen block. If the development build doesn't exist in the project, eWizard.js runs the wiz dev command automatically.

{
"path": {
"blocks": "common/blocks-library"
}
}

TIP: For the wiz screen block command, you can generate the block icons for the specific theme and specific target systems in the icon-[THEME_NAME]-[CLM_COD].png format. To do this, you must have THEME_NAME specified as the current theme and CLM_CODE specified as code in the ./settings.json file. For more information, see Default and current theme and Configure blocks for target systems.

eWizard CLI supports the following target systems:

Target system	Name	Code
Viseven	`Viseven`	`viseven`
Veeva Vault	`Veeva Vault`	`veeva`
Salesforce Marketing Cloud	`Salesforce Marketing Cloud`	`sfmc`
Salesforce.com	`Salesforce`	`sfdc`
IQVIA	`IQVIA`	`iqvia`
IQVIA OCE Sales	`OCE Sales`	`oce-sales`
UniSender	`Unisender`	`unisender`
Mailchimp	`Mailchimp`	`mailchimp`
Oracle Eloqua	`Eloqua`	`eloqua`
Adobe Campaign	`Adobe Campaign`	`adobe`

For more information, see Configure blocks for target systems.

The wiz screen block command has the following options:

Option	Description
`-a` or `--all`	Generates the icon screenshots for all the blocks, all themes, and all target systems. For example, `wiz screen block -a`.
`-c [CLM_CODE]` or `--clm [CLM_CODE]`	Generates the `icon-[THEME_NAME]-[CLM_CODE].png` icon files for all themes and the specified target system for each block in your email project. For example, `wiz screen block -c oce-sales`.
`-t [THEME_NAME]` or `--theme [THEME_NAME]`	Generates the `icon-[THEME_NAME]-[CLM_CODE].png` icon files for all target systems and the specified theme for each block in your email project. For example, `wiz screen block -t viseven-dark`.
`-t [THEME_NAME] -c [CLM_CODE]` or `--theme [THEME_NAME] --clm [CLM_CODE]`	Generates the `icon-[THEME_NAME]-[CLM_CODE].png` icon files for the specified theme and target system for each block in your email project. For example, `wiz screen block -t viseven-dark -c oce-sales`.
`-i [BLOCK_ID]` or `--id [BLOCK_ID]`	Generates the `icon-[THEME_NAME]-[CLM_CODE].png` icon files for the specified block in your email project. For example, `wiz screen block -i header-1a`.
`-i [BLOCK_ID] -c [CLM_CODE]` or `--id [BLOCK_ID] --clm [CLM_CODE]`	Generates the `icon-[THEME_NAME]-[CLM_CODE].png` icon files for the specified block, all themes, and the specified target system in your email project.
`-i [BLOCK_ID] -t [THEME_NAME]` or `--id [BLOCK_ID] --theme [THEME_NAME]`	Generates the `icon-[THEME_NAME]-[CLM_CODE].png` icon file for the specified block, specified theme, and specified target system in your email project.
`-h` or `--help`	Shows help for the `wiz screen block` command and options. For example, `wiz screen -h`.

See the detailed description of the wiz screen block options below.

1) To generate the icon screenshots for all the blocks, all themes, and all target systems:

wiz screen block -a

This command generates the icon-[THEME_NAME]-[CLM_CODE].png icon files for all themes and target systems for each block in your email project. eWizard CLI takes THEME_NAME from the id field in the ./themes/themes.json file and uses CLM_CODE from the list of target systems.

//./themes/themes.json
{
"themes": [
{
"id": "viseven",
"name": "Viseven",
"dependencies": {
"brand": ["viseven"]
}
},
{
"id": "viseven-dark",
"name": "Viseven dark",
"dependencies": {
"brand": ["viseven"]
}
}
]
}

2) To generate the icon screenshots for all the blocks, all themes, and one specific target system:

wiz screen block -c [CLM_CODE]

Here, CLM_CODE is the code of the target system. For example, run wiz screen block -c oce-sales to generate the icons in the following format: icon-viseven-oce-sales, icon-viseven-dark-oce-sales.png, etc.

This command generates the icon-[THEME_NAME]-[CLM_CODE].png icon files for all themes and the specified target system for each block in your email project. eWizard CLI takes THEME_NAME from the id field in the ./themes/themes.json file.

3) To generate the icon screenshots for all the blocks, all target systems, and one specific theme:

wiz screen block -t [THEME_NAME]

Here, THEME_NAME is the id of the specified theme from the ./themes/themes.json file. For example, run wiz screen block -t viseven-dark to generate the icons in the following format: icon-viseven-dark-oce-sales.png, icon-viseven-dark-veeva.png, etc.

This command generates the icon-[THEME_NAME]-[CLM_CODE].png icon files for all target systems and the specified theme for each block in your email project. eWizard CLI uses CLM_CODE from the list of target systems.

4) To generate the icon screenshots for all the blocks, one specific target system, and one specific theme:

wiz screen block -t [THEME_NAME] -c [CLM_CODE]

For example, run wiz screen block -t viseven-dark -c oce-sales to generate the blocks icons in the following format: icon-viseven-dark-oce-sales.png.

This command generates the icon-[THEME_NAME]-[CLM_CODE].png icon files for the specified theme and target system for each block in your email project. eWizard CLI takes THEME_NAME from the id field in the ./themes/themes.json file.

5) To generate the icon screenshots of one block for all themes and target systems:

wiz screen block -i [BLOCK_ID]

Here, BLOCK_ID is the id field for the block in the ./common/blocks-library/blocks.json file. For example, run wiz screen block -i header-1a to generate icons of the same block in the following format: icon-viseven-dark-oce-sales.png, icon-viseven-iqvia.png, etc.

This command generates the icon-[THEME_NAME]-[CLM_CODE].png icon files for the specified block in your email project. eWizard CLI takes THEME_NAME from the id field in the ./themes/themes.json file and uses CLM_CODE from the list of target systems.

6) To generate the icon screenshots of one block for all themes and one target system:

wiz screen block -i [BLOCK_ID] -c [CLM_CODE]

For example, run wiz screen block -i header-1a -c oce-sales to generate icons of the same block in the following format: icon-viseven-dark-oce-sales.png, icon-viseven-oce-sales.png, etc.

This command generates the icon-[THEME_NAME]-[CLM_CODE].png icon files for the specified block, all themes, and the specified target system in your email project. eWizard CLI takes THEME_NAME from the id field in the ./themes/themes.json file and uses CLM_CODE from the list of target systems.

7) To generate the icon screenshots of one block for one theme and all target systems:

wiz screen block -i [BLOCK_ID] -t [THEME_NAME]

For example, run wiz screen block -i header-1a -t viseven-dark to generate icons of the same block in the following format: icon-viseven-dark-oce-sales.png, icon-viseven-dark-iqvia.png, etc.

This command generates the icon-[THEME_NAME]-[CLM_CODE].png icon files for the specified block, specified theme, and all target systems in your email project. eWizard CLI takes THEME_NAME from the id field in the ./themes/themes.json file and uses CLM_CODE from the list of target systems.

8) To generate the icon screenshot of one block for one theme and one target system:

wiz screen block -i [BLOCK_ID] -t [THEME_NAME] -c [CLM_CODE]

For example, run wiz screen block -i header-1a -t viseven-dark -c oce-sales to generate an icon of the specified block in the following format: icon-viseven-dark-oce-sales.png.

This command generates the icon-[THEME_NAME]-[CLM_CODE].png icon file for the specified block, specified theme, and specified target system in your email project. eWizard CLI takes THEME_NAME from the id field in the ./themes/themes.json file and uses CLM_CODE from the list of target systems.

wiz docs [options]

Use the wiz docs command to open the documentation site for eWizard.js and eWizard CLI. When you run this command, eWizard CLI opens the eWizard.js framework documentation site in your default browser.

Option	Description
`--edetailer`	Opens the e-Detailer development documentation section. For example, `wiz docs --edetailer`.
`--email`	Opens the Email development documentation section. For example, `wiz docs --email`.
`--site`	Opens the Site development documentation section. For example, `wiz docs --site`.
`-h` or `--help`	Shows help for the `wiz docs` command and options. For example, `wiz docs -h`.

wiz update [options]

Use the options of the wiz update or wiz up command to update:

• the dependencies from the package.json file of your project: eWizard.js blocks, components, or npm packages

NOTE: The command works only for public GitLab repositories and npm packages. You need to --skip the dependencies of components installed from CodeArtifact.

After running wiz update, eWizard CLI checks the versions of the dependencies in your project and updates them to the latest versions of their major releases. The command skips the components that have the latest versions installed.

• the version of the e-Detailer structure file

• the version of the references file

TIP: For more information about the major/minor versions and patches, see Semantic Versioning 2.0.0.

After you run the wiz update command, eWizard CLI automatically launches the wiz dev command if the e-Detailer structure file, the references file, or at least one of the dependencies has been updated.

The wiz update command has the following options:

Option	Description
`--major`	Updates the dependencies to the latest versions of the last major release. For more information, see wiz update --major.
`--no-major`	Updates the dependencies to the latest versions of the same major release. For more information, see wiz update --no-major.
`--skip`	Skips a component. For example, to update all components except `wiz-accordion`, run `wiz update --skip wiz-accordion`. For more information, see wiz update --skip.
`--structure`	Updates the version of the e-Detailer structure file. For more information, see wiz update --structure.
`--references`	Updates the version of the references file. For more information, see wiz update --references.
`-h` or `--help`	Shows help for the `wiz update` command and options. For example, `wiz update -h`.

TIP: The --structure and --references options don't affect the dependencies in package.json.

See the detailed description of the wiz update options later in this article.

wiz update

To update all GitLab and npm dependencies in a project, run:

wiz update

• When the current dependency version is from a previous major release, you can choose the latest version for each major release after running wiz update.

TIP: If you choose the version of the dependency that's already installed, the dependency is skipped and isn't updated.

For example, the current version of the wiz-block component in the project is the latest in a previous major release—1.0.1. The version of the wiz-button component is from a previous major release—v1.4.1:

// package.json{
"dependencies": {
"wiz-block": "git+https://git.qapint.com/ewizardjs/edetailer/components/wiz-block.git#1.0.1",
"wiz-button": "git+https://git.qapint.com/ewizardjs/edetailer/components/wiz-button.git#v1.4.1",
}
}

After running wiz update, you can choose the versions to update wiz-block and wiz-button to.

You can leave wiz-block on the same version—1.0.1, or update wiz-block to the 2.0.0 version.

You can install one of the latest versions of wiz-button from each major release: v1.4.3, 2.0.1, or 3.0.7.

In this example, wiz-block is updated to the 2.0.0 version and wiz-button—to version 2.0.1:

// package.json{
"dependencies": {
"wiz-block": "git+https://git.qapint.com/ewizardjs/edetailer/components/wiz-block.git#2.0.0",
"wiz-button": "git+https://git.qapint.com/ewizardjs/edetailer/components/wiz-button.git#2.0.1"
}
}

• When the current dependency version is from the latest major release, wiz update updates the version to the latest release.

For example, the current version of the wiz-text component in the project is from the latest major release—2.0.1:

// package.json{
"dependencies": {
"wiz-text": "git+https://git.qapint.com/ewizardjs/edetailer/components/wiz-text.git#2.0.1"
}
}

The latest version of the component in the wiz-text repository is in the same major release—2.0.3.

After running wiz update, the wiz-text version is updated to the latest 2.0.3 version of the latest major release:

// package.json{
"dependencies": {
"wiz-text": "git+https://git.qapint.com/ewizardjs/edetailer/components/wiz-text.git#2.0.3"
}
}

• When a component in package.json has a dependency to a branch, you can choose either the latest component version in the latest major release, or the version from the specified branch.

NOTE: The --major and --no-major options don't apply if the component has a dependency to a branch.

For example, the wiz-button has a dependency with the develop branch in the repository:

// package.json{
"dependencies": {
"wiz-button": "git+https://git.qapint.com/ewizardjs/edetailer/components/wiz-button.git#develop",
}
}

After running wiz update, you can choose either the latest 4.0.0 version, or the develop version:

wiz update [DEPENDENCY_NAME]

To update a specific dependency, run:

wiz update [DEPENDENCY_NAME]

DEPENDENCY_NAME is the name of the dependency in the package.json file.

For example, the ewizardjs version:

wiz update ewizardjs

You can also update multiple dependencies at once, such as the wiz-button component and the @blocks/header-1a block:

wiz update wiz-button @blocks/header-1a

NOTE: The component name must be the same as in the package.json file of the repository.

Update specific components using the same version logic as for the wiz update command.

wiz update --major

To update all GitLab and npm components to the latest versions of their last major releases, run:

wiz update --major

For example, the wiz-button repository has the v1.4.3, 2.0.1, and 3.0.7 latest versions in each major release. The current version of the wiz-button component in the project is from a previous major release—v1.4.1. The wiz-text repository has the v1.3.3 and 2.0.3 latest versions in each major release. The current version of the wiz-text component in the project is from the latest major release—2.0.1

// package.json{
"dependencies": {
"wiz-button": "git+https://git.qapint.com/ewizardjs/edetailer/components/wiz-button.git#v1.4.1",
"wiz-text": "git+https://git.qapint.com/ewizardjs/edetailer/components/wiz-text.git#2.0.1"
}
}

After running the wiz update --major command, the wiz-button and wiz-text components are updated to the latest versions of the last major releases: 3.0.7 and 2.0.3, respectively:

// package.json{
"dependencies": {
"wiz-button": "git+https://git.qapint.com/ewizardjs/edetailer/components/wiz-button.git#3.0.7",
"wiz-text": "git+https://git.qapint.com/ewizardjs/edetailer/components/wiz-text.git#2.0.3"
}
}

wiz update --no-major

To update all GitLab and npm dependencies without changing the major version, run:

wiz update --no-major

For example, the wiz-button repository has the v1.4.3, 2.0.1, and 3.0.7 latest versions in each major release. The current version of the wiz-button component in the project is v1.4.1:

// package.json{
"dependencies": {
"wiz-button": "git+https://git.qapint.com/ewizardjs/edetailer/components/wiz-button.git#v1.4.1",
}
}

After running wiz update --no-major, the wiz-button component is updated to the latest patch version of the same major release, which is v1.4.3:

// package.json{
"dependencies": {
"wiz-button": "git+https://git.qapint.com/ewizardjs/edetailer/components/wiz-button.git#v1.4.3",
}
}

wiz update --skip

To skip updating a dependency, for example, the @edetailer/wiz-references CodeArtifact component, run:

wiz update --skip @edetailer/wiz-references

Or, the wiz-button component and the @blocks/content-2a block:

wiz update --skip wiz-button @blocks/content-2a

wiz update --structure

To update the e-Detailer structure.json file from version 1 to version 2, run:

wiz update --structure

The differences between versions 1 and 2 are the following:

• Additional structureFileVersion field that shows the version of the ./structure.json file.

• The updated chapter structure.

• The subslides are now added to the chapters object instead of the slides object.

• New hidden field instead of the ! symbol to hide slides, subslides, and chapters.

• Added the possibility to archive slides.

For more information, see Slides and chapters structure.

wiz update --structure uses the methods of the Structure API to update the structure.json version.

Hidden slides and chapters from structure.json version 1 are converted to version 2 as follows:

• Version 1 slides that aren't in a chapter or hidden with ! are converted to version 2 as archived.

• Version 1 chapters that aren't in a storyboard or hidden with ! are converted to version 2 as hidden. Chapters can't be archived.

wiz update --references

Starting from eWizard.js 5.18.0, the references.json file doesn't include language keys, and the default path to the file is common/resources/references.json. For more information, see Localization of references in eWizard.js 5.18.0 and later and References.

To update the references.json structure and move it to the ./common/resources directory, run:

wiz update --references

The command checks the references.json path defined in system settings.

wiz create [options]

Use the wiz create commands to create an archive of a monorepo eWizard template or a master template layout.

To create an archive of an eWizard template from a master template, run:

wiz create ewizard-template

TIP: wiz create ewizard-template works only with monorepo emails.

To create an archive of an email layout, run:

wiz create layout

The wiz create layout and wiz create ewizard-template commands have the following options:

Option	Description
`--from [LAYOUT_NAME]`	Archives an eWizard template, or a master template layout from the specified layout directory. For example, `wiz create layout --from layout1`.
`--name [LAYOUT_NAME]`	Sets a name for the archive eWizard template or layout. For example, `wiz create layout --from layout1 --name myarchive`. The `--name` option works only for one layout at a time.
`--target [TARGET_CLM]`	Adds configuration for the specified target system to the `./settings.json` in the archived email project. For example, run wiz create `ewizard-template --target viseven`. This command adds the `targetCLM` field that has the `viseven` value for code and `Viseven` for name in the `settings.json` file of your archived email project. See the list of target systems with codes.
`--theme [THEME_NAME]`	Generates the email project archive with the specified theme name. For example, run `wiz create layout --theme viseven`. This command adds `viseven` as the current theme in the `./settings.json` file of the zipped project.
`--scheme`	Generates the email project archive with the specified scheme name. For example, run `wiz create ewizard-template --scheme viseven`. This command adds the `viseven` value for the `scheme` field in the theme object of the `./settings.json` file of the zipped project. The `scheme` field isn't used at the moment.
`--from-all`	Creates an archive from all layouts of the email project.
`--no-archive`	Saves the email project locally without creating an archive.
`-h` or `--help`	Shows help for the `wiz create` command and options. For example, `wiz create -h`.

See the detailed option descriptions below.

--from

Use the --from option to archive an ewizard template or layout. The command archives the layout from the directory defined in the layouts field in system settings.

To archive an eWizard template from a master template, run:

wiz create ewizard-template --from [LAYOUT_NAME]

[LAYOUT_NAME] is the name of the layout of the master template.

As a result, the layout1 folder is archived as an eWizard template. The master template settings are added as a dependency in the package.json file:

// ./package.json{
"dependencies": {
"master": "git+https://git.qapint.com/myrepository"
}

To archive a specific email layout, run:

wiz create layout --from [LAYOUT_NAME]

[LAYOUT_NAME] is the name of the layout or workspace located in the ./layouts folder of the master template or ewizard-template respectfully.

For example, to archive a layout from layout1:

wiz create layout --from layout1

--name

Use the --name option to archive an eWizard template or layout with a specific name.

For example, to archive an eWizard template with the my_archive name:

wiz create ewizard-template --from layout1 --name my_archive

To archive a layout with the my_archive name:

wiz create layout --from layout1 --name my_archive

--target

Use the --target option to change the target system settings in the resulting archive. The option updates the targetCLM field in the ./settings.json file of the email.

For example, to change the target system settings to veeva:

• In the eWizard template archive:

wiz create ewizard-template --from layout1 --target veeva

• In the layout or workspace archive:

wiz create layout --from layout1 --target veeva

As a result, the targetCLM field is updated as follows:

// ./settings.json{
"targetCLM": {
"name": "Veeva Vault",
"code": "veeva"
}
}

--theme

Use the --theme option to set the current theme of the archive. The option updates the current field in the theme object of the ./settings.json file.

For example, to update the current theme to theme1:

• In the eWizard template archive:

wiz create ewizard-template --from layout1 --theme theme1

• In the layout or workspace archive:

wiz create layout --from layout1 --theme theme1

As a result, the current theme is updated as follows:

// ./settings.json{
"theme": {
"default": "theme2",
"current": "theme1",
"scheme": "scheme1"
}
}

--scheme

Use the --scheme option to update the scheme of the archive. The option updates the scheme field in the theme object of the ./settings.json file.

To update the scheme field:

• In the eWizard template archive:

wiz create ewizard-template --scheme scheme2

• In the layout or workspace archive:

wiz create layout --scheme scheme2

As a result, the ./settings.json file is updated as follows:

// ./settings.json{
"theme": {
"default": "theme2",
"current": "theme1",
"scheme": "scheme2"
}
}

--from-all

Use the --from-all option to create an archive from all layouts.

To create an eWizard template archive from all layouts:

wiz create ewizard-template --from-all

To create a layout or workspace archive from all layouts:

wiz create layout --from-all

--no-archive

Use the --no-archive option to save the email directory on your computer without archiving it.

To save an eWizard template on your computer:

wiz create ewizard-template --from-all --no-archive

To save a layout on your computer:

wiz create layout --from layout1 --no-archive

wiz clone

With the wiz clone command, you can clone any item from eWizard Editor, like an e-Detailer, email, or site.

Cloned projects are useful for collaborative editing: you can work on them with someone else at the same time. Update a project on your computer and push your version upstream with the wiz push command. You can also pull changes pushed by someone else with the wiz pull command.

To clone a project on your computer:

1) Go to an empty directory where you want to clone the project to.

For example, create the my-cloned-edetailer directory and then:

cd my-cloned-edetailer

2) In the empty directory, run:

wiz clone [PROJECT_ID]

[PROJECT_ID] is the ID of your project in eWizard Editor. You can copy it from the address bar of your browser.

As a result, the directory with the source files is created in the project.

The wiz clone command has the following options:

Option	Description
`-h` or `--help`	Shows help for the `wiz clone` command and options. For example, `wiz clone -h`.

wiz push

Use the wiz push command to overwrite the changes in the :Upstreamproject:upstreamproject: with the changes from your cloned project.

wiz push

The wiz push command has the following options:

Option	Description
`--force`	Overwrites the changes in the upstream project with local changes. For example `wiz push --force`.
`-h` or `--help`	Shows help for the `wiz push` command and options. For example, `wiz push -h`.

wiz pull

The wiz pull command allows you to overwrite the changes in your cloned project with the changes from the :Upstreamproject:upstreamproject:.

wiz pull

The wiz pull command has the following options:

Option	Description
`--accept`	Used for resolving merge conflicts based on the specified option. The `--accept local` option discards the changes in the upstream project and saves the changes made locally. The `--accept upstream` option overwrites local changes with the changes from the upstream project.
`-h` or `--help`	Shows help for the `wiz pull` command and options. For example, `wiz pull -h`.

The wiz pull command supports version control.

For example, a project in eWizard Editor with a button on the layout with BUTTON TEXT.

After you clone the project and open it in eWizard.js, the file looks like this:

<i18n>
{
    "eng": {
        "wiz_button_42e8": "<div style=\"line-height:16px;text-align:center;\"><span style=\"color:#fafafa;font-size:14px;\">BUTTON TEXT</span></div>"
    }
}
</i18n>

In eWizard.js the button text is changed to BUTTON TEXT 1:

<i18n>
{
    "eng": {
        "wiz_button_42e8": "<div style=\"line-height:16px;text-align:center;\"><span style=\"color:#fafafa;font-size:14px;\">BUTTON TEXT 1</span></div>"
    }
}
</i18n>

In eWizard Editor the text is changed to BUTTON TEXT 2:

After running the wiz pull command, there is a merge conflict.

To resolve the merge conflict you can:

• Apply your local changes

Or use the wiz pull --accept local command

• Overwrite your local changes

Or use the wiz pull --accept upstream command

• Fix conflicts in files individually

This opens the merge conflict tool of your code editor: