@amp-nova/amp-rsa-cli

amprsa

Command line interface for Amplience Reference Storefront Architecture.

Description

amprsa is a command line interface application to manage an installation of the Amplience Reference Storefront Architecture (amprsa).

Run amprsa --help to get a list of available commands.

• Prerequisites
• Installation
• Configuration
• Command categories
  • using an amprsa environment
  • env management
• Configure your own Automated Content

Installation

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

npm install -g @amp-nova/amp-rsa-cli

Configuration

amprsa requires an AMPRSA environment configuration to run.

PreRequisites

• Amplience account ( Think about what we say here)
• Details and where to get then from.
  • hub name (Env)
  • App URL - link to RSA-CORE
  • Client ID / Secret - Sent via support@amplience.com - One Time Secret
  • Hub ID - Screenshot of DC / Settings page
  • Username & Password for Content Hub - Automate VSE details.

On your first invocation of any amprsa command, the CLI will prompt you to create an environment:

dave@po:~ $ amprsa env add
✔ env name: foo
✔ app deployment url: https://foo.baz.com
✔ cms client id: amplience-client-id
✔ cms client secret: ***********************
✔ cms hub id: hub-id-from-hub-settings-properties
✔ dam username: foo@baz.com
✔ dam password: *****************
info: [ foo ] configure dc-cli...
info: [ foo ] environment active

You will set these to the values you received from Amplience Support when you created your account.

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

Options

Option Name	Type	Description
--version	[boolean]	Show version number
--config	[string] [default: "~/.amplience/dc-cli-config.json"]	Path to JSON config file
--help	[boolean]	Show help

Command categories

using an amprsa environment

• Commands
  • show
  • env
  • import
  • cleanup
  • publish

Common Options

The following options are available for all content-type-schema commands.

Option Name	Type	Description
--version	[boolean]	Show version number
--help	[boolean]	Show help

Commands

cleanup

Clean a hub.

Options

Option Name	Type	Description
--logRequests, -r	[boolean]	log http requests/responses
--tempDir, -t	[string]	temp dir for run files
--matchingSchema, -m	[array]	apply to (types, schemas, items) matching schema id
--include, -i	[array]	types to include
--skipConfirmation, -c	[boolean]	don't ask for confirmation
--all, -a	[boolean]	clean up all resource types

Valid resource types are contentTypeSchema, contentTypes, contentItems, searchIndexes, extensions, webhooks, and events.

Examples

Clean a hub

amprsa cleanup

Clean content types, schemas, and items without asking for confirmation

amprsa cleanup -ci contentTypes -i contentTypeSchema -i contentItems

import

Import data.

Options

Option Name	Type	Description
--logRequests, -r	[boolean]	log http requests/responses
--tempDir, -t	[string]	temp dir for run files
--matchingSchema, -m	[array]	apply to (types, schemas, items) matching schema id
--automationDir, -a	[string]	path to import directory
--skipContentImport, -s	[boolean]	skip content import
--latest, -l	[boolean]	using this flag will download the latest automation

Examples

Import the latest automation data

amprsa import -l

Import only items matching schema 'schema'

amprsa import -m <schema>

publish

Publish all unpublished content items.

Options

Option Name	Type	Description
--logRequests, -r	[boolean]	log http requests/responses
--tempDir, -t	[string]	temp dir for run files
--matchingSchema, -m	[array]	apply to (types, schemas, items) matching schema id

Examples

Publish

amprsa publish

show

Show the status of an amprsa environment.

Examples

amprsa show

env

This category includes interactions with environments.

View commands for env