@une-protecmedia/itersdk v0.1.6

Iter WCM SDK

Description

Iter WCM SDK allows Iter web site developers to work on web designs using their preferred development environment and tools.

Iter WCM SDK handles the interception of the pages of an Iter site by expanding the compact and minified bundles of web resources (e.g. javascripts, styles) to local source files, allowing debugging and review of changes in real time without the need to deploy the web design in production.

Installation

npm i @une-protecmedia/itersdk -g

Usage

iter-sdk --help

Commands:
  iter-sdk init <url> <username> <password>  Authenticate the user
  iter-sdk pull [sitename]                   Retrieve theme files
  iter-sdk push [sitename]                   Push the modified theme files
  iter-sdk serve <sitename> <url>            Review your changes in real time

Options:
      --version       Show version number
  -w, --workspace     Set the working directory
  -v, --verbose       Show debug messages
  -h, --help          Show help

Workspace initialization

iter-sdk init <url> <username> <password>

Initializes the workspace:

• Create the necessary folders.
• Authenticate the user in Milenium.
• Download global velocity macros.

Arguments

  url       URL of the authentication service
  username  User to authenticate
  password  Password of the user to authenticate

Options

-m, --macros-folder  Name of the velocity macros folder [default: "_velocimacros"]

Downloading the web design of the site

iter-sdk pull [sitename]

Download the web design of the site (if a sitename was specified) or global velocity templates into the workspace.

Arguments

  sitename  The name of the site in Milenium

Real-time change review

iter-sdk serve <url>

Raise the server to monitor changes in web designs in real time.

Arguments

  url       The working URL

Options

-p, --port  The listening port of the application [default: 4200]

Uploading the web design of the site

iter-sdk push [sitename]