techiedarren/dc-cli

Dynamic Content CLI Tool

dc-cli

Command line interface for Amplience Dynamic Content service.

Description

dc-cli is a command line interface application for Amplience Dynamic Content management APIs.

Run dc-cli to get a list of available commands

Configuration

dc-cli requires a valid set of Amplience client credentials (--client-key & --client-secret) and hub ID (--hub-id) to operate. These parameters must be set using the command dc-cli configure --client-key <KEY> --client-secret <SECRET> --hub-id <ID> before using the CLI.

Once the tool has been configured the individual parameters can be overwritten by supplying them when running any of the commands, e.g dc-cli <command> <action> --hub-id <ID>.

By default the configuration is saved to a file in the directory <HOME_DIR>/.amplience/, this can be overridden using the --config option.

See dc-cli configure --help for more information.

Installation

Installing the DC CLI from the NPM package manager can be achieved using the following command:

npm install -g @amplience/dc-cli

Or you can download the executable for your operating system from our download page https://amplience.com/dc-cli/downloads

Building the CLI

We have included some NPM scripts to help create various installations of the CLI and in this section we will include instructions of how to:

• Compile TypeScript to JavaScript
• Package the CLI into executables
• Link the CLI with NPM for local development

Compiling TypeScript to Javascript

We are using the TypeScript command tsc to compile the code to JavaScript and the output of which is put into the dist directory. A NPM script has been created to run this compile step and can be utilised if you want to just use the raw JavaScript.

The command to achieve this is:

npm run build

Building Executables

Prerequisites:

• ronn is required to convert the markdown HOW_TO_USE.md to the manpage

To support the use of the CLI as a standalone application within Windows, Linux and Mac OS we have added a step to export the code as an executable. This step can be achieved by running the command:

npm run build:package

The output of this command will be three executables within the packages directory, one for Linux, Mac OS and Windows:

• dc-cli-linux
• dc-cli-macos
• dc-cli-win.exe

Creating a versioned zipped set of executables is also achievable using the following command:

npm run build:compress

Where the output of this command will also be created in the packages directory, they will now be zip files for each OS with a version:

• dc-cli-linux-1.0.0-0.zip
• dc-cli-macos-1.0.0-0.zip
• dc-cli-win-1.0.0-0.zip

Linking with NPM for local development

To run the CLI locally via the command prompt for local development the application must first be compiled. Once compiled the CLI can then be linked with NPM to act like it has been installed, to achieve this we can run the script:

npm link

This will then allow the CLI to be used as if it was an executable like so:

dc-cli COMMAND --param1 foo -- param2 bar

Required permissions

Outlined below are the permissions required to run each command of the CLI. To request any permissions please contact Amplience support.

Command	Required ACL(s)	Required Functional Permission(s)
configure	* Hub - READ
content-repositories get <id>	* Hub - READ	* CONTENT:FUNCTIONAL:REPOSITORY:READ
content-repositories list	* Hub - READ	* CONTENT:FUNCTIONAL:REPOSITORY:READ
content-repositories assign-content-type <id>	* ContentRepository - EDIT * Hub - READ	* CONTENT:FUNCTIONAL:REPOSITORY:EDIT
content-repositories unassign-content-type <id>	* ContentRepository - EDIT * Hub - READ	* CONTENT:FUNCTIONAL:REPOSITORY:EDIT
content-type get <id>	* Hub - READ	* CONTENT:FUNCTIONAL:CONTENT_TYPE:READ
content-type list	* Hub - READ	* CONTENT:FUNCTIONAL:CONTENT_TYPE:READ
content-type register	* Hub - READ	* CONTENT:FUNCTIONAL:CONTENT_TYPE:CREATE
content-type sync <id>	* Hub - READ	* CONTENT:FUNCTIONAL:CONTENT_TYPE:EDIT
content-type update <id>	* Hub - READ	* CONTENT:FUNCTIONAL:CONTENT_TYPE:EDIT
content-type import <dir>	* ContentRepository - EDIT * Hub - READ	* CONTENT:FUNCTIONAL:CONTENT_TYPE:READ * CONTENT:FUNCTIONAL:CONTENT_TYPE:CREATE * CONTENT:FUNCTIONAL:CONTENT_TYPE:EDIT
content-type export <dir>	* Hub - READ	* CONTENT:FUNCTIONAL:CONTENT_TYPE:READ
content-type-schema create	* Hub - READ	* CONTENT:FUNCTIONAL:CONTENT_TYPE:CREATE
content-type-schema get <id>	* Hub - READ	* CONTENT:FUNCTIONAL:CONTENT_TYPE:READ
content-type-schema list	* Hub - READ	* CONTENT:FUNCTIONAL:CONTENT_TYPE:READ
content-type-schema update <id>	* Hub - READ	* CONTENT:FUNCTIONAL:CONTENT_TYPE:EDIT
content-type-schema import <dir>	* Hub - READ	* CONTENT:FUNCTIONAL:CONTENT_TYPE:READ * CONTENT:FUNCTIONAL:CONTENT_TYPE:CREATE * CONTENT:FUNCTIONAL:CONTENT_TYPE:EDIT