@amplience/dc-demostore-cli
Demonstration Command line interface for Amplience Demo Store.
Description
demostore is a command line interface application to manage an installation of the Amplience Demo Store (demostore). It builds on top of the Amplience DC CLI and Amplience Management APIs
Run demostore --help
to get a list of available commands.
Installation
Installing the demostore CLI from the NPM package manager can be achieved using the following command:
npm install -g @amplience/dc-demostore-cli
Configuration
demostore requires an demostore environment configuration to run.
PreRequisites
- Amplience account
- Details and where to get then from.
- Hub Name
-
App URL - ( link to your deployed
dc-demostore-core
app ) - Client ID / Secret - Sent via support@amplience.com - One Time Secret
- Hub ID
- Username & Password for Content Hub
On your first invocation of any demostore
command, the CLI will prompt you to create an environment:
dave@po:~ $ demostore env add
✔ env name: hub-name-from-hub-settings-properties
✔ app deployment url: https://your-deployed-dc-demostore-core-url.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 demostore environment
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
demostore cleanup
Clean content types, schemas, and items without asking for confirmation
demostore 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
demostore import -l
Import only items matching schema 'schema'
demostore 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
demostore publish
show
Show the status of an demostore environment.
Examples
demostore show
env
This category includes interactions with environments.