Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
@amplience/dc-demostore-cli
Advanced tools
Readme
Demonstration Command line interface for Amplience Demo Store.
dc-demostore-cli
or CLI alias 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.
See v2.0.0 Changes if you already have an existing version of demostore that you wish to update.
This demo appliction was developed and tested with:
To switch to the correct node version it is recommended to have Node Version Manager installed.
nvm install 18
nvm use 18
Installing the demostore CLI from the NPM package manager can be achieved using the following command:
npm install -g @amplience/dc-demostore-cli
demostore requires a demostore environment configuration to run.
dc-demostore-core
app )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.
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 |
The following options are available for all content-type-schema commands.
Option Name | Type | Description |
---|---|---|
--version | [boolean] | Show version number |
--help | [boolean] | Show help |
Clean a hub.
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
.
Content Items containing one of the following active field will go through an additional process:
filterActive
active
If these properties are true
, the cleanup process will:
false
demostore cleanup
demostore cleanup -ci contentTypes -i contentTypeSchema -i contentItems
Import data using automation packages found in dc-demostore-automation
When running an import you get provided with the environment variables to configure for your Front End deployment of dc-demostore-core. See specific information in the docs on this project about how to use.
Example output after import where all values marked as XXX
will be specific to your account configuration
info: .env.local file format
info:
----------------------- COPY START ----------------------
NEXT_PUBLIC_DEMOSTORE_CONFIG_JSON='{"url":"XXX","algolia":{"appId":"XXX","apiKey":"XXX"},"cms":{"hub":"XXX","stagingApi":"XXX","imageHub":"XXX"}}'
------------------------ COPY END -----------------------
info:
info: Vercel format
info:
----------------------- COPY START ----------------------
{"url":"XXX","algolia":{"appId":"XXX","apiKey":"XXX"},"cms":{"hub":"XXX","stagingApi":"XXX","imageHub":"XXX"}}
------------------------ COPY END -----------------------
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 |
--openaiKey, -o | [string] | optional openai key for generative rich text automation |
demostore import -l
demostore import -m <schema>
Publish all unpublished content items.
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 |
demostore publish
Show the status of a demostore environment.
demostore show
This category includes interactions with environments.
FAQs
Amplience Demo Store CLI
The npm package @amplience/dc-demostore-cli receives a total of 1 weekly downloads. As such, @amplience/dc-demostore-cli popularity was classified as not popular.
We found that @amplience/dc-demostore-cli demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 12 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.