@commercetools/cli
Advanced tools
A command-line interface (CLI) tool for interacting with commercetools products. For more information, visit the commercetools Documentation.
To install the commercetools CLI, you need Node.js (version 18.20 or higher) and npm (version 6 or higher) installed on your system.
npm install -g @commercetools/cli
commercetools --version
After installing, you can use the CLI tool with the following command:
commercetools [command] [options]
commercetools auth logincommercetools connect application addcommercetools connect application buildcommercetools connect application startcommercetools connect application testcommercetools connect bundlecommercetools connect connectorstaged certifycommercetools connect connectorstaged createcommercetools connect connectorstaged listcommercetools connect connectorstaged previewcommercetools connect connectorstaged publishcommercetools connect connectorstaged updatecommercetools connect init DIRECTORYcommercetools connect validate [DIRECTORY]commercetools auth loginLogin to commercetools
USAGE
$ commercetools auth login --client-credentials --client-id <value> --client-secret <value> --region <value>
--project-key <value> [--scope <value>]
FLAGS
--client-credentials (required) Use client credentials authentication flow
--client-id=<value> (required) The client ID associated with your commercetools API client
--client-secret=<value> (required) The client secret associated with your commercetools API client
--project-key=<value> (required) The project key for your commercetools project
--region=<value> (required) The commercetools API region to authenticate against (e.g., "europe-west1.gcp")
--scope=<value> Specify the scopes to granted for the access token
DESCRIPTION
Login to commercetools
commercetools connect application addAdd an application to your existing Connect project
USAGE
$ commercetools connect application add [--language <value>] [--type <value>]
FLAGS
--language=<value> The language template to use in your new application.
--type=<value> The application type of your new application.
DESCRIPTION
Add an application to your existing Connect project
commercetools connect application buildBuild your Connect application
USAGE
$ commercetools connect application build
DESCRIPTION
Build your Connect application
commercetools connect application startStart your Connect application
USAGE
$ commercetools connect application start
DESCRIPTION
Start your Connect application
commercetools connect application testRun your Connect application tests
USAGE
$ commercetools connect application test
DESCRIPTION
Run your Connect application tests
commercetools connect bundleBundle your Connect applications
USAGE
$ commercetools connect bundle
DESCRIPTION
Bundle your Connect applications
commercetools connect connectorstaged certifyInitiates the certification process for a staged connector.
USAGE
$ commercetools connect connectorstaged certify [--id <value>] [--key <value>]
FLAGS
--id=<value> The unique identifier for the staged connector to be certified. You must specify either `id` or `key`.
--key=<value> The key for the staged connector to be certified. You must specify either `id` or `key`.
DESCRIPTION
Initiates the certification process for a staged connector.
commercetools connect connectorstaged createCreate a new connector-staged.
USAGE
$ commercetools connect connectorstaged create --repository-url <value> --repository-tag <value> --creator-email <value> --name
<value> [--key <value>] [--description <value>] [--supported-regions
us-central1.gcp|europe-west1.gcp|australia-southeast1.gcp|eastus.azure...] [--integration-types
tax|marketplace|oms|psp|pim|promotion|search|erp|crm|email|analytics|shipping|other...]
FLAGS
--creator-email=<value> (required) Email address of the connector creator.
--description=<value> Description of the connector.
--integration-types=<option>... Comma-separated list of integration types to classify the connector.
<options:
tax|marketplace|oms|psp|pim|promotion|search|erp|crm|email|analytics|shipping|other>
--key=<value> Unique key to identify the connector.
--name=<value> (required) Name of the connector.
--repository-tag=<value> (required) Git tag identifying the code version to use.
--repository-url=<value> (required) Git repository URL hosting the connector.
--supported-regions=<option>... Comma-separated list of regions supported by the connector.
<options: us-central1.gcp|europe-west1.gcp|australia-southeast1.gcp|eastus.azure>
DESCRIPTION
Create a new connector-staged.
commercetools connect connectorstaged listUSAGE
$ commercetools connect connectorstaged list [--limit <value>] [--offset <value>] [--sort <value>]
FLAGS
--limit=<value> [default: 20] The maximum number of items to return in a single page of results.
--offset=<value> The number of items to skip before starting to return results.
--sort=<value> Specifies the field by which to sort the results. Available fields are 'createdAt' and
'lastModifiedAt'.
commercetools connect connectorstaged previewInitiates the required validations and creates a preview deployment of a staged connector.
USAGE
$ commercetools connect connectorstaged preview --deployment-key <value> --region
us-central1.gcp|europe-west1.gcp|australia-southeast1.gcp|eastus.azure --configuration <value>... [--id <value>]
[--key <value>]
FLAGS
--configuration=<value>... (required) Specifies configuration key-value pairs following the pattern
'applicationName.key=value' to be used in the preview deployment.
--deployment-key=<value> (required) Deployment key to associate with the preview deployment.
--id=<value> Identifier for the staged connector to preview. Must specify either `id` or `key`.
--key=<value> Key for the staged connector to preview. Must specify either `id` or `key`.
--region=<option> (required) Specifies the region where the preview deployment will take place.
<options: us-central1.gcp|europe-west1.gcp|australia-southeast1.gcp|eastus.azure>
DESCRIPTION
Initiates the required validations and creates a preview deployment of a staged connector.
commercetools connect connectorstaged publishInitiates the publishing process for a staged connector.
USAGE
$ commercetools connect connectorstaged publish [--id <value>] [--key <value>]
FLAGS
--id=<value> The unique identifier for the staged connector to be published. You must specify either `id` or `key`.
--key=<value> The key for the staged connector to be published. You must specify either `id` or `key`.
DESCRIPTION
Initiates the publishing process for a staged connector.
commercetools connect connectorstaged updateUpdate an existing connector-staged, such as its name, description, repository, or supported regions.
USAGE
$ commercetools connect connectorstaged update [--id <value>] [--key <value>] [--repository-url <value>] [--repository-tag
<value>] [--creator-email <value>] [--name <value>] [--description <value>] [--supported-regions
us-central1.gcp|europe-west1.gcp|australia-southeast1.gcp|eastus.azure...] [--integration-types
tax|marketplace|oms|psp|pim|promotion|search|erp|crm|email|analytics|shipping|other...]
FLAGS
--creator-email=<value> Email address of the connector creator.
--description=<value> Description of the connector.
--id=<value> Identifier for the connector to update. Must specify either `id` or `key`.
--integration-types=<option>... Comma-separated list of integration types to classify the connector.
<options:
tax|marketplace|oms|psp|pim|promotion|search|erp|crm|email|analytics|shipping|other>
--key=<value> Key for the connector to update. Must specify either `id` or `key`.
--name=<value> Name of the connector.
--repository-tag=<value> Git tag identifying the code version to use.
--repository-url=<value> Git repository URL hosting the connector.
--supported-regions=<option>... Comma-separated list of regions supported by the connector.
<options: us-central1.gcp|europe-west1.gcp|australia-southeast1.gcp|eastus.azure>
DESCRIPTION
Update an existing connector-staged, such as its name, description, repository, or supported regions.
commercetools connect init DIRECTORYInitialize a new Connect project
USAGE
$ commercetools connect init DIRECTORY [--template
tax-integration|product-ingestion|email-integration|payment-integration|fulfilment-integration]
ARGUMENTS
DIRECTORY project directory
FLAGS
--template=<option> The template to bootstrap the project with.
<options:
tax-integration|product-ingestion|email-integration|payment-integration|fulfilment-integration>
DESCRIPTION
Initialize a new Connect project
commercetools connect validate [DIRECTORY]Validate your Connect applications
USAGE
$ commercetools connect validate [DIRECTORY] [--skip tests|analysis]
ARGUMENTS
DIRECTORY [default: .] connect project directory
FLAGS
--skip=<option> Skip the specified validation step. Options are 'test' or 'analysis'.
<options: tests|analysis>
DESCRIPTION
Validate your Connect applications
This project is licensed under the MIT License.
FAQs
Unknown package
The npm package @commercetools/cli receives a total of 230 weekly downloads. As such, @commercetools/cli popularity was classified as not popular.
We found that @commercetools/cli demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 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.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.