Command Line

The Cloud CMS command-line client gives developers a way to work with their Cloud CMS tenant projects, applications, data stores and other resources from the command line. The CLI (command-line client) is a Node.js based command line tool that is very easy to use and available at no charge.

Note: A valid Cloud CMS subscription is required to connect to Cloud CMS with the command-line client. This subscription can be a paid subscription or a free trial account.

Getting Started

client.

Step 1: Install Node.js

Run the installer and pick all the default options. You're all set!

Step 2: Install the Cloud CMS command-line client

And then run,

npm install cloudcms-cli -g

Step 3: Connect to Cloud CMS

cloudcms init

And walk through the prompts. You will be asked for the URL to your UI server. If you're connecting to a trial account, this will be something like https://mytenant.cloudcms.net. For the API server, you can put https://api.cloudcms.com.

If you're connecting to a locally installed Cloud CMS environment that uses the Docker samples that we provide, the UI server will typically be http://localhost and the API server may be http://localhost:8080.

If you're otherwise connecting to an on-premise or self-hosted instance of Cloud CMS, please check with your system administrator for information about the URLs to use for the UI and API servers.

To get your Cloud CMS client keys and login credentials,
   visit "https://gitana.io".

Enter the URL to your Cloud CMS UI endpoint: https://mytenant.cloudcms.net
Enter the URL to your Cloud CMS API endpoint: https://api.cloudcms.com
Enter your username: myUsername
Enter your password: myPassword

Testing connectivity...
Successfully connected to Cloud CMS!

Cloud CMS platform connection credentials were saved to:
   /Users/username/.cloudcms/credentials.json

You can also invoke this using switches, like this:

cloudcms init --ui https://mytenant.cloudcms.net --api https://api.cloudcms.com --username myUsername --password myPassword

Usage

In general, you run the command line tool like this:

cloudcms <command> [switches]

Many commands are also grouped. Grouped commands work like this:

cloudcms <group> <command> [switches]

Switches are either key/value pairs or booleans. Key/value pairs are specified in the form --<key> <value>. Booleans are simply specified as --<key>.

To see the list of commands, simply type:

cloudcms

You can then pull up commands for a group, like this:

cloudcms <group>

To pull up information about a specific command, use the --help switch.

cloudcms <command> --help
cloudcms <group> <command> --help

To see the version of the command line tool:

cloudcms --version

Using an .rc file

You can create an .rc file and populate it with command line arguments that you would like to have automatically get passed in by default. This is very useful when working with a repository or branch where you have fixed IDs that you know ahead of time.

The .rc file should sit in the same directory as where you're executing the command line tool.

Here is a sample .rc file:

{
  "global": {
      "arguments": {
        "repository": "7d18d8bafa6923e6d126",
        "branch": "2b2fac2fdb6ae406fe8f",
        "pretty": "true"
      }
  }
}

With this .rc file in place, a command like:

cloudcms node query --repository 7d18d8bafa6923e6d126 --branch 2b2fac2fdb6ae406fe8f --query "{'rating': { '$gt': 3 }}" --pretty

Can be run like this:

cloudcms node query --query "{'rating': { '$gt': 3 }}"

Or you might pull back the children of a node at a given path like this:

cloudcms node children --path /System/Themes

Using the .last_command file

When the command line tool runs, a file named .last_command will be generated that stores the arguments and options passed to the tool on the previous invocation.

If you pass the --last switch to the command line client, the tool will scan the current directory for a .last_command file. If one is found, it will be picked up and the values from within will be merged in.

This provides a way for values passed in to the command line tool to be preserved so that they can be used on subsequent calls.

Here is an example of what the .last_command file may look like:

{
  "command": {
    "group": "node",
    "name": "relatives"
  },
  "arguments": {
    "repository": "894e48dcc5a2fa248e8d",
    "branch": "master"
  }
}

Connecting with Multiple Profiles

You can manage multiple Cloud CMS connection profiles and select between them using the --profile switch. For example,

cloudcms init --profile dev

Will walk you through the prompts to initialize a connection to Cloud CMS. The resulting file is saved to:

~/.cloudcms/credentials/dev.json

You can use the --profile switch to connect to multiple Cloud CMS clusters, each with their own stored credentials.

You can then invoke commands and use the --profile switch to pick which profile to use. For example:

cloudcms platform list-repositories --profile dev

This will list all of the repositories on the dev environment.

Examples

Here are a few examples of how the tool is used.

Query for Nodes on a branch

Find all content where the rating is greater than 3:

cloudcms node query --repository 7d18d8bafa6923e6d126 --branch 2b2fac2fdb6ae406fe8f --query "{'rating': { '$gt': 3 }}"

Find all content where the rating is greater than 3 and hand back 25 items starting while sorting by customer.name ascending and format things to be readable:

cloudcms node query --repository 7d18d8bafa6923e6d126 --branch 2b2fac2fdb6ae406fe8f --query "{'rating': { '$gt': 3 }}" --limit 50 --sort "{'customer.name': -1}" --pretty

Find all content where rating is less than 5 and limit the response so that we only get back the title and customer fields:

cloudcms node query --repository 7d18d8bafa6923e6d126 --branch 2b2fac2fdb6ae406fe8f --query "{'rating': { '$lt': 5 }}" --fields "{'title': 1, 'customer': 1}" --pretty

Search for Nodes on a branch

Find all content where the word hello appears in the text:

cloudcms node search --repository 7d18d8bafa6923e6d126 --branch 2b2fac2fdb6ae406fe8f --text "hello"

Find all content where the word hello appears and hand back 50 items starting at the 100th entry while sorting by title descending and format things to be readable:

cloudcms node search --repository 7d18d8bafa6923e6d126 --branch 2b2fac2fdb6ae406fe8f --text "hello" --limit 50 --skip 100 --sort "{'title': -1}" --pretty

Commands Reference

init

Usage

Name Required Type Switches Description
ui required string --ui The URL to your Cloud CMS UI endpoint (example: https://mytenant.cloudcms.net or http://localhost)
api required string --api, --a The URL to your Cloud CMS API endpoint (example: https://api.cloudcms.com or http://localhost:8080)
username required string --username, --user, --name, --u Your Cloud CMS user name
password required string --password, --pass, --pw, --p Your Cloud CMS password

Example

cloudcms init  --ui <ui> --api <api> --username <username> --password <password>

admin

compress-repository

Usage

Name Required Type Switches Description
repositoryId required string --repositoryId, --repository, --r Enter the repository ID
branchId string --branchId, --branch, --b Enter the branch ID
force boolean --force, --f Whether to force compression to start from beginning
username required string --username, --u Admin username
password required string --password, --p Admin password

Example

cloudcms admin compress-repository  --repositoryId <repositoryId> [--branchId <branchId>] [--force] --username <username> --password <password>

get-cluster-healthcheck

Usage

Name Required Type Switches Description
username required string --username, --u Admin username
password required string --password, --p Admin password

Example

cloudcms admin get-cluster-healthcheck  --username <username> --password <password>

get-cluster-stats

Usage

Name Required Type Switches Description
username required string --username, --u Admin username
password required string --password, --p Admin password

Example

cloudcms admin get-cluster-stats  --username <username> --password <password>

get-cluster-threaddump

Usage

Name Required Type Switches Description
http boolean --http Filter to include active http handler threads
worker boolean --worker Filter to include job processing worker threads
username required string --username, --u Admin username
password required string --password, --p Admin password

Example

cloudcms admin get-cluster-threaddump  [--http] [--worker] --username <username> --password <password>

get-cluster-values

Usage

Name Required Type Switches Description
username required string --username, --u Admin username
password required string --password, --p Admin password

Example

cloudcms admin get-cluster-values  --username <username> --password <password>

get-jobqueue-stats

Usage

Name Required Type Switches Description
username required string --username, --u Admin username
password required string --password, --p Admin password

Example

cloudcms admin get-jobqueue-stats  --username <username> --password <password>

import-platform-datastore

Usage

Name Required Type Switches Description
platformId required string --platformId, --platform Enter the platform ID
datastoreTypeId required string --datastoreTypeId, --type Enter the data store type ID
datastoreId required string --datastoreId, --id Enter the data store ID
username required string --username, --u Admin username
password required string --password, --p Admin password

Example

cloudcms admin import-platform-datastore  --platformId <platformId> --datastoreTypeId <datastoreTypeId> --datastoreId <datastoreId> --username <username> --password <password>

inspect-datastore

Usage

Name Required Type Switches Description
datastoreTypeId required string --datastoreTypeId, --type Enter the data store type ID
datastoreId required string --datastoreId, --id Enter the data store ID
username required string --username, --u Admin username
password required string --password, --p Admin password

Example

cloudcms admin inspect-datastore  --datastoreTypeId <datastoreTypeId> --datastoreId <datastoreId> --username <username> --password <password>

kill-cluster-job

Usage

Name Required Type Switches Description
id required string --id Enter the job ID
username required string --username, --u Admin username
password required string --password, --p Admin password

Example

cloudcms admin kill-cluster-job  --id <id> --username <username> --password <password>

kill-cluster-jobs

Usage

Name Required Type Switches Description
state required string --state Enter the state
username required string --username, --u Admin username
password required string --password, --p Admin password

Example

cloudcms admin kill-cluster-jobs  --state <state> --username <username> --password <password>

list-cluster-jobs

Usage

Name Required Type Switches Description
skip number --skip, --s Enter the pagination skip
limit number --limit, --l Enter the pagination limit
sort string --sort, --x Enter the pagination sort JSON
username required string --username, --u Admin username
password required string --password, --p Admin password

Example

cloudcms admin list-cluster-jobs  [--skip <skip>] [--limit <limit>] [--sort <sort>] --username <username> --password <password>

list-datastore-deletions

Usage

Name Required Type Switches Description
text boolean --text Hand back the result as text output
username required string --username, --u Admin username
password required string --password, --p Admin password

Example

cloudcms admin list-datastore-deletions  [--text] --username <username> --password <password>

list-environments

Usage

Name Required Type Switches Description
username required string --username, --u Admin username
password required string --password, --p Admin password

Example

cloudcms admin list-environments  --username <username> --password <password>

migrate-datastore

Usage

Name Required Type Switches Description
datastoreTypeId required string --datastoreTypeId, --type Enter the data store type ID
datastoreId required string --datastoreId, --id Enter the data store ID
sourceEnvironmentId required string --sourceEnvironmentId, --sourceEnv Enter the source environment ID
targetEnvironmentId required string --targetEnvironmentId, --targetEnv Enter the target environment ID
overwrite boolean --overwrite, --o Whether to overwrite the datastore in the target environment if it already exists
username required string --username, --u Admin username
password required string --password, --p Admin password

Example

cloudcms admin migrate-datastore  --datastoreTypeId <datastoreTypeId> --datastoreId <datastoreId> --sourceEnvironmentId <sourceEnvironmentId> --targetEnvironmentId <targetEnvironmentId> [--overwrite] --username <username> --password <password>

query-cluster-jobs

Usage

Name Required Type Switches Description
query required string --query, --q Enter the query JSON
skip number --skip, --s Enter the pagination skip
limit number --limit, --l Enter the pagination limit
sort string --sort, --x Enter the pagination sort JSON
username required string --username, --u Admin username
password required string --password, --p Admin password

Example

cloudcms admin query-cluster-jobs  --query <query> [--skip <skip>] [--limit <limit>] [--sort <sort>] --username <username> --password <password>

read-cluster-job

Usage

Name Required Type Switches Description
id required string --id Enter the job ID
username required string --username, --u Admin username
password required string --password, --p Admin password

Example

cloudcms admin read-cluster-job  --id <id> --username <username> --password <password>

read-environment

Usage

Name Required Type Switches Description
environment required string --environment, --env, --e Environment
username required string --username, --u Admin username
password required string --password, --p Admin password

Example

cloudcms admin read-environment  --environment <environment> --username <username> --password <password>

refresh-db-connections

Usage

Name Required Type Switches Description
username required string --username, --u Admin username
password required string --password, --p Admin password

Example

cloudcms admin refresh-db-connections  --username <username> --password <password>

reindex-datastore

Usage

Name Required Type Switches Description
datastoreTypeId required string --datastoreTypeId, --type Enter the data store type ID
datastoreId required string --datastoreId, --id Enter the data store ID
children boolean --children, --c Whether to index any child data stores as well
username required string --username, --u Admin username
password required string --password, --p Admin password

Example

cloudcms admin reindex-datastore  --datastoreTypeId <datastoreTypeId> --datastoreId <datastoreId> [--children] --username <username> --password <password>

repair-branch

Usage

Name Required Type Switches Description
repositoryId required string --repository, --r Enter the repository ID
branchId required string --branch, --b Enter the branch ID
operation string --operation, --op Allows for optional specification of which operations to perform (tips, danglingAssociations, incorrectChangesets)
commit boolean --commit Automatically commits repairs for any issues found with the branch
typeQNames string --typeQName, --type (Only for relators operation) Type QNames to repair instances of
username required string --username, --u Admin username
password required string --password, --p Admin password

Example

cloudcms admin repair-branch  --repository <repositoryId> --branch <branchId> [--operation <operation>] [--commit] [--typeQName <typeQNames>] --username <username> --password <password>

set-cluster-value

Usage

Name Required Type Switches Description
key required string --key, --k The key to retrieve
value required string --value, --val, --v The value to set
bool boolean --boolean, --bool Whether the value is true/false
int boolean --integer, --int Whether the value is an integer
username required string --username, --u Admin username
password required string --password, --p Admin password

Example

cloudcms admin set-cluster-value  --key <key> --value <value> [--boolean] [--integer] --username <username> --password <password>

sync-repository-anchor-snapshots

Usage

Name Required Type Switches Description
repositoryId required string --repository, --r Enter the repository ID
username required string --username, --u Admin username
password required string --password, --p Admin password

Example

cloudcms admin sync-repository-anchor-snapshots  --repository <repositoryId> --username <username> --password <password>

validate-branch

Usage

Name Required Type Switches Description
repositoryId required string --repository, --r Enter the repository ID
branchId required string --branch, --b Enter the branch ID
nodeList boolean --nodeList Hand back a list of affected node IDs
repair boolean --repair Automatically repairs any affected nodes by refreshing them
typeQNames string --typeQName, --type Type QNames to validate instances of
username required string --username, --u Admin username
password required string --password, --p Admin password

Example

cloudcms admin validate-branch  --repository <repositoryId> --branch <branchId> [--nodeList] [--repair] [--typeQName <typeQNames>] --username <username> --password <password>

application

download-api-keys

Usage

Name Required Type Switches Description
applicationId required string --application, --app, --a The ID of the application where the branch lives
deploymentKey string --deployment, --d The deployment key
out string --out, --o The output file path

Example

cloudcms application download-api-keys  --application <applicationId> [--deployment <deploymentKey>] [--out <out>]

archive

download

Usage

Name Required Type Switches Description
vaultId string --vault, --v The ID of the vault containing the archive
group required string --group, --g The group ID of the archive that should be downloaded
artifact required string --artifact, --a The artifact ID of the archive that should be downloaded
version required string --version, --v The version of the archive that should be downloaded

Example

cloudcms archive download  [--vault <vaultId>] --group <group> --artifact <artifact> --version <version>

upload

Usage

Name Required Type Switches Description
vaultId string --vault, --v The ID of the vault containing the archive
group required string --group, --g The group ID of the archive that should be created after upload
artifact required string --artifact, --a The artifact ID of the archive that should be created after upload
version required string --version, --v The version of the archive that should be created after upload

Example

cloudcms archive upload  [--vault <vaultId>] --group <group> --artifact <artifact> --version <version>

branch

build-view

Usage

Name Required Type Switches Description
repositoryId required string --repository, --r Enter the repository ID
branchId required string --branch, --b Enter the branch ID

Example

cloudcms branch build-view  --repository <repositoryId> --branch <branchId>

create-node

Usage

Name Required Type Switches Description
repositoryId required string --repository, --r Enter the repository ID
branchId required string --branch, --b Enter the branch ID
object string --object, --o, --node Enter the object JSON

Example

cloudcms branch create-node  --repository <repositoryId> --branch <branchId> [--object <object>]

create-path-index

Usage

Name Required Type Switches Description
repositoryId required string --repository, --r Enter the repository ID
branchId required string --branch, --b Enter the branch ID

Example

cloudcms branch create-path-index  --repository <repositoryId> --branch <branchId>

create-search-index

Usage

Name Required Type Switches Description
repositoryId required string --repository, --r Enter the repository ID
branchId required string --branch, --b Enter the branch ID

Example

cloudcms branch create-search-index  --repository <repositoryId> --branch <branchId>

delete-path-index

Usage

Name Required Type Switches Description
repositoryId required string --repository, --r Enter the repository ID
branchId required string --branch, --b Enter the branch ID

Example

cloudcms branch delete-path-index  --repository <repositoryId> --branch <branchId>

delete-search-index

Usage

Name Required Type Switches Description
repositoryId required string --repository, --r Enter the repository ID
branchId required string --branch, --b Enter the branch ID

Example

cloudcms branch delete-search-index  --repository <repositoryId> --branch <branchId>

export

Usage

Name Required Type Switches Description
repositoryId required string --repository, --r The ID of the repository where the branch lives
branchId string --branch, --b The ID of the branch
group required string --group, --g The group ID of the archive that should be exported
artifact required string --artifact, --a The artifact ID of the archive that should be exported
version required string --version, --v The version of the archive that should be exported

Example

cloudcms branch export  --repository <repositoryId> [--branch <branchId>] --group <group> --artifact <artifact> --version <version>

get-search-index

Usage

Name Required Type Switches Description
repositoryId required string --repository, --r Enter the repository ID
branchId required string --branch, --b Enter the branch ID

Example

cloudcms branch get-search-index  --repository <repositoryId> --branch <branchId>

import

Usage

Name Required Type Switches Description
group required string --group, --g The group ID of the archive that should be imported
artifact required string --artifact, --a The artifact ID of the archive that should be imported
version required string --version, --v The version of the archive that should be imported
repositoryId required string --repository, --r The ID of the Repository where the target Branch lives
branchId required string --branch, --b The ID of the target Branch

Example

cloudcms branch import  --group <group> --artifact <artifact> --version <version> --repository <repositoryId> --branch <branchId>

list-definitions

Usage

Name Required Type Switches Description
repositoryId required string --repository, --r Enter the repository ID
branchId string --branch, --b The ID of the branch
filter string --filter Either 'type', 'association' or 'feature'
system boolean --system Should system definitions be included?
custom boolean --custom Should custom definitions be included?
skip number --skip, --s Enter the pagination skip
limit number --limit, --l Enter the pagination limit
sort string --sort, --x Enter the pagination sort JSON

Example

cloudcms branch list-definitions  --repository <repositoryId> [--branch <branchId>] [--filter <filter>] [--system] [--custom] [--skip <skip>] [--limit <limit>] [--sort <sort>]

query-nodes

Usage

Name Required Type Switches Description
repositoryId required string --repository, --r Enter the repository ID
branchId required string --branch, --b Enter the branch ID
query string --query, --q Enter the query JSON
skip number --skip, --s Enter the pagination skip
limit number --limit, --l Enter the pagination limit
sort string --sort, --x Enter the pagination sort JSON

Example

cloudcms branch query-nodes  --repository <repositoryId> --branch <branchId> [--query <query>] [--skip <skip>] [--limit <limit>] [--sort <sort>]

read-node

Usage

Name Required Type Switches Description
repositoryId required string --repository, --r Enter the repository ID
branchId required string --branch, --b Enter the branch ID
nodeId string --node, --n, --id Enter the node ID
path string --path Enter the node path

Example

cloudcms branch read-node  --repository <repositoryId> --branch <branchId> [--node <nodeId>] [--path <path>]

rebase

Usage

Name Required Type Switches Description
repositoryId required string --repository, --r Enter the repository ID
branchId required string --branch, --b Enter the branch ID
rootChangesetId required string --root, --changesetId, --c Enter the new root changeset ID

Example

cloudcms branch rebase  --repository <repositoryId> --branch <branchId> --root <rootChangesetId>

recreate-filenames

Usage

Name Required Type Switches Description
repositoryId required string --repository, --r Enter the repository ID
branchId required string --branch, --b Enter the branch ID

Example

cloudcms branch recreate-filenames  --repository <repositoryId> --branch <branchId>

reset

Usage

Name Required Type Switches Description
repositoryId required string --repository, --r Enter the repository ID
branchId required string --branch, --b Enter the branch ID
tipChangesetId required string --tip, --changeset, --c Enter the new tip changeset ID

Example

cloudcms branch reset  --repository <repositoryId> --branch <branchId> --tip <tipChangesetId>

revert

Usage

Name Required Type Switches Description
repositoryId required string --repository, --r Enter the repository ID
branchId required string --branch, --b Enter the branch ID
tipChangesetId required string --tip, --changeset, --c Enter the new tip changeset ID

Example

cloudcms branch revert  --repository <repositoryId> --branch <branchId> --tip <tipChangesetId>

search-nodes

Usage

Name Required Type Switches Description
repositoryId required string --repository, --r Enter the repository ID
branchId required string --branch, --b Enter the branch ID
query string --query, --q Enter the query JSON
text string --text, --t Enter the text to search for
skip number --skip, --s Enter the pagination skip
limit number --limit, --l Enter the pagination limit
sort string --sort, --x Enter the pagination sort JSON

Example

cloudcms branch search-nodes  --repository <repositoryId> --branch <branchId> [--query <query>] [--text <text>] [--skip <skip>] [--limit <limit>] [--sort <sort>]

validate-nodes

Usage

Name Required Type Switches Description
repositoryId required string --repository, --r Enter the repository ID
branchId required string --branch, --b Enter the branch ID

Example

cloudcms branch validate-nodes  --repository <repositoryId> --branch <branchId>

validate-search-index

Usage

Name Required Type Switches Description
repositoryId required string --repository, --r Enter the repository ID
branchId required string --branch, --b Enter the branch ID
repair boolean --repair Automatically repair any discrepancies with the index

Example

cloudcms branch validate-search-index  --repository <repositoryId> --branch <branchId> [--repair]

datastore

get-value

Usage

Name Required Type Switches Description
datastoreTypeId required string --type The type of the data store
datastoreId required string --id The ID of the data store
key required string --key, --k The key to retrieve

Example

cloudcms datastore get-value  --type <datastoreTypeId> --id <datastoreId> --key <key>

read

Usage

Name Required Type Switches Description
datastoreTypeId required string --type The type of the data store
datastoreId required string --id The ID of the data store

Example

cloudcms datastore read  --type <datastoreTypeId> --id <datastoreId>

remove-value

Usage

Name Required Type Switches Description
datastoreTypeId required string --type The type of the data store
datastoreId required string --id The ID of the data store
key required string --key, --k The key to retrieve

Example

cloudcms datastore remove-value  --type <datastoreTypeId> --id <datastoreId> --key <key>

set-value

Usage

Name Required Type Switches Description
datastoreTypeId required string --type The type of the data store
datastoreId required string --id The ID of the data store
key required string --key, --k The key to retrieve
value required string --value, --val, --v The value to set
bool boolean --boolean, --bool Whether the value is true/false
int boolean --integer, --int Whether the value is an integer

Example

cloudcms datastore set-value  --type <datastoreTypeId> --id <datastoreId> --key <key> --value <value> [--boolean] [--integer]

db

get-indexes

Usage

Name Required Type Switches Description
datastoreTypeId string --datastoreTypeId, --type Enter the data store type ID
datastoreId string --datastoreId, --id Enter the data store ID
children boolean --children, --c Whether to index any child data stores as well
include string --includes, --include Comma-delimited regex string of paths to include
exclude string --excludes, --exclude Comma-delimited regex string of paths to exclude
username required string --username, --u Admin username
password required string --password, --p Admin password

Example

cloudcms db get-indexes  [--datastoreTypeId <datastoreTypeId>] [--datastoreId <datastoreId>] [--children] [--includes <include>] [--excludes <exclude>] --username <username> --password <password>

get-system-indexes

Usage

Name Required Type Switches Description
datastoreTypeId string --datastoreTypeId, --type Enter the data store type ID
datastoreId string --datastoreId, --id Enter the data store ID
children boolean --children, --c Whether to index any child data stores as well
include string --includes, --include Comma-delimited regex string of paths to include
exclude string --excludes, --exclude Comma-delimited regex string of paths to exclude
username required string --username, --u Admin username
password required string --password, --p Admin password

Example

cloudcms db get-system-indexes  [--datastoreTypeId <datastoreTypeId>] [--datastoreId <datastoreId>] [--children] [--includes <include>] [--excludes <exclude>] --username <username> --password <password>

repair-indexes

Usage

Name Required Type Switches Description
datastoreTypeId string --datastoreTypeId, --type Enter the data store type ID
datastoreId string --datastoreId, --id Enter the data store ID
children boolean --children, --c Whether to index any child data stores as well
force boolean --force, --f Whether to force the recreation of indexes (even if they're in a good state)
include string --includes, --include Comma-delimited regex string of paths to include ( / / )
exclude string --excludes, --exclude Comma-delimited regex string of paths to exclude ( / / )
username required string --username, --u Admin username
password required string --password, --p Admin password

Example

cloudcms db repair-indexes  [--datastoreTypeId <datastoreTypeId>] [--datastoreId <datastoreId>] [--children] [--force] [--includes <include>] [--excludes <exclude>] --username <username> --password <password>

validate-indexes

Usage

Name Required Type Switches Description
datastoreTypeId string --datastoreTypeId, --type Enter the data store type ID
datastoreId string --datastoreId, --id Enter the data store ID
children boolean --children, --c Whether to index any child data stores as well
force boolean --force, --f Whether to force the recreation of indexes (even if they're in a good state)
include string --includes, --include Comma-delimited regex string of paths to include
exclude string --excludes, --exclude Comma-delimited regex string of paths to exclude
username required string --username, --u Admin username
password required string --password, --p Admin password

Example

cloudcms db validate-indexes  [--datastoreTypeId <datastoreTypeId>] [--datastoreId <datastoreId>] [--children] [--force] [--includes <include>] [--excludes <exclude>] --username <username> --password <password>

deployment

find-deployment-records

Usage

Name Required Type Switches Description
repositoryId required string --repository, --r Enter the repository ID
branchId required string --branch, --b Enter the branch ID
nodeId required string --node, --id Enter a node ID

Example

cloudcms deployment find-deployment-records  --repository <repositoryId> --branch <branchId> --node <nodeId>

domain

list-group-members

Usage

Name Required Type Switches Description
domainId required string --domain, --d Enter the domain ID
principalId required string --group, --g, --id, --principal, --p Enter the group ID
indirect string --indirect Include indirect members (children of children)
skip number --skip, --s Enter the pagination skip
limit number --limit, --l Enter the pagination limit
sort string --sort, --x Enter the pagination sort JSON

Example

cloudcms domain list-group-members  --domain <domainId> --group <principalId> [--indirect <indirect>] [--skip <skip>] [--limit <limit>] [--sort <sort>]

list-memberships

Usage

Name Required Type Switches Description
domainId required string --domain, --d Enter the domain ID
principalId required string --principal, --p, --id Enter the principal ID
principalId required string --principal, --p, --id Enter the principal ID
indirect string --indirect Include indirect members (children of children)
skip number --skip, --s Enter the pagination skip
limit number --limit, --l Enter the pagination limit
sort string --sort, --x Enter the pagination sort JSON

Example

cloudcms domain list-memberships  --domain <domainId> --principal <principalId> --principal <principalId> [--indirect <indirect>] [--skip <skip>] [--limit <limit>] [--sort <sort>]

list-principals

Usage

Name Required Type Switches Description
domainId required string --domain, --d Enter the domain ID
skip number --skip, --s Enter the pagination skip
limit number --limit, --l Enter the pagination limit
sort string --sort, --x Enter the pagination sort JSON

Example

cloudcms domain list-principals  --domain <domainId> [--skip <skip>] [--limit <limit>] [--sort <sort>]

query-principals

Usage

Name Required Type Switches Description
domainId required string --domain, --d Enter the domain ID
query string --query, --q Enter the query JSON
skip number --skip, --s Enter the pagination skip
limit number --limit, --l Enter the pagination limit
sort string --sort, --x Enter the pagination sort JSON

Example

cloudcms domain query-principals  --domain <domainId> [--query <query>] [--skip <skip>] [--limit <limit>] [--sort <sort>]

read-principal

Usage

Name Required Type Switches Description
domainId required string --domain, --d Enter the domain ID
principalId required string --principal, --p, --id Enter the principal ID

Example

cloudcms domain read-principal  --domain <domainId> --principal <principalId>

fs

ls

Usage

Name Required Type Switches Description
repositoryId required string --repository, --r Enter the repository ID
branchId required string --branch, --b Enter the branch ID
path string --path, --p Enter the path

Example

cloudcms fs ls  --repository <repositoryId> --branch <branchId> [--path <path>]

hosting

deploy

Usage

Name Required Type Switches Description
applicationId required string --application, --a The ID of the application
deploymentKey string --deployment, --d The deployment key

Example

cloudcms hosting deploy  --application <applicationId> [--deployment <deploymentKey>]

info

Usage

Name Required Type Switches Description
applicationId required string --application, --a The ID of the application
deploymentKey string --deployment, --d The deployment key

Example

cloudcms hosting info  --application <applicationId> [--deployment <deploymentKey>]

open

Usage

Name Required Type Switches Description
applicationId required string --application, --a The ID of the application
deploymentKey string --deployment, --d The deployment key

Example

cloudcms hosting open  --application <applicationId> [--deployment <deploymentKey>]

start

Usage

Name Required Type Switches Description
applicationId required string --application, --a The ID of the application
deploymentKey string --deployment, --d The deployment key

Example

cloudcms hosting start  --application <applicationId> [--deployment <deploymentKey>]

start

Usage

Name Required Type Switches Description
applicationId required string --application, --a The ID of the application
deploymentKey string --deployment, --d The deployment key

Example

cloudcms hosting start  --application <applicationId> [--deployment <deploymentKey>]

stop

Usage

Name Required Type Switches Description
applicationId required string --application, --a The ID of the application
deploymentKey string --deployment, --d The deployment key

Example

cloudcms hosting stop  --application <applicationId> [--deployment <deploymentKey>]

undeploy

Usage

Name Required Type Switches Description
applicationId required string --application, --a The ID of the application
deploymentKey string --deployment, --d The deployment key

Example

cloudcms hosting undeploy  --application <applicationId> [--deployment <deploymentKey>]

latency

server

Usage

Name Required Type Switches Description
url required string --url, --u Enter the URL to execute against:

Example

cloudcms latency server  --url <url>

log

download

Usage

Name Required Type Switches Description
project string --project Enter the project ID

Example

cloudcms log download  [--project <project>]

module

deploy

Usage

Name Required Type Switches Description
id required string --id Enter the module ID

Example

cloudcms module deploy  --id <id>

list

Example

cloudcms module list

redeploy

Usage

Name Required Type Switches Description
id required string --id Enter the module ID

Example

cloudcms module redeploy  --id <id>

register

Usage

Name Required Type Switches Description
id required string --id Enter the module ID
sourceType required string --sourceType, --type Enter the module source type
sourceUrl required string --sourceUrl, --url Enter the module source URL
sourcePath string --sourcePath, --path Enter the module source path
sourceBranch string --sourceBranch, --branch Enter the module source branch

Example

cloudcms module register  --id <id> --sourceType <sourceType> --sourceUrl <sourceUrl> [--sourcePath <sourcePath>] [--sourceBranch <sourceBranch>]

undeploy

Usage

Name Required Type Switches Description
id required string --id Enter the module ID

Example

cloudcms module undeploy  --id <id>

unregister

Usage

Name Required Type Switches Description
id required string --id Enter the module ID

Example

cloudcms module unregister  --id <id>

node

children

Usage

Name Required Type Switches Description
repositoryId required string --repository, --r Enter the repository ID
branchId required string --branch, --b Enter the branch ID
nodeId string --node, --n, --id Enter the node ID
path string --path Enter the node path
query string --query, --q Enter the query JSON
skip number --skip, --s Enter the pagination skip
limit number --limit, --l Enter the pagination limit
sort string --sort, --x Enter the pagination sort JSON

Example

cloudcms node children  --repository <repositoryId> --branch <branchId> [--node <nodeId>] [--path <path>] [--query <query>] [--skip <skip>] [--limit <limit>] [--sort <sort>]

relatives

Usage

Name Required Type Switches Description
repositoryId required string --repository, --r Enter the repository ID
branchId required string --branch, --b Enter the branch ID
nodeId string --node, --n, --id Enter the node ID
path string --path Enter the node path
associationDirection string --associationDirection, --direction Enter the direction of the association related to this node
associationType string --associationType, --atype Enter the type of the association related to this node
query string --query, --q Enter the query JSON
skip number --skip, --s Enter the pagination skip
limit number --limit, --l Enter the pagination limit
sort string --sort, --x Enter the pagination sort JSON

Example

cloudcms node relatives  --repository <repositoryId> --branch <branchId> [--node <nodeId>] [--path <path>] [--associationDirection <associationDirection>] [--associationType <associationType>] [--query <query>] [--skip <skip>] [--limit <limit>] [--sort <sort>]

versions

Usage

Name Required Type Switches Description
repositoryId required string --repository, --r Enter the repository ID
branchId required string --branch, --b Enter the branch ID
nodeId required string --node, --n, --id Enter the node ID
skip number --skip, --s Enter the pagination skip
limit number --limit, --l Enter the pagination limit
sort string --sort, --x Enter the pagination sort JSON
excludeSystem boolean --exclude_system, --ex_sys, --exsys Whether to exclude system modified documents in the results

Example

cloudcms node versions  --repository <repositoryId> --branch <branchId> --node <nodeId> [--skip <skip>] [--limit <limit>] [--sort <sort>] [--exclude_system]

patch

apply

Usage

Name Required Type Switches Description
datastoreTypeId string --datastoreTypeId, --type Enter the data store type ID
datastoreId string --datastoreId, --id Enter the data store ID
patch required boolean --patch, --p Identifies the patch to apply
force boolean --force, --f Whether to force the patch application
username required string --username, --u Admin username
password required string --password, --p Admin password

Example

cloudcms patch apply  [--datastoreTypeId <datastoreTypeId>] [--datastoreId <datastoreId>] --patch <patch> [--force] --username <username> --password <password>

list

Usage

Name Required Type Switches Description
username required string --username, --u Admin username
password required string --password, --p Admin password

Example

cloudcms patch list  --username <username> --password <password>

platform

create-project

Usage

Name Required Type Switches Description
title required string --title, --t Enter the project title
description string --description, --d Enter optional project description
type string --type, --y Enter optional project type id or url

Example

cloudcms platform create-project  --title <title> [--description <description>] [--type <type>]

create-repository

Usage

Name Required Type Switches Description
object string --object, --o Enter the object JSON

Example

cloudcms platform create-repository  [--object <object>]

get-jobs-summary

Example

cloudcms platform get-jobs-summary

info

Example

cloudcms platform info

list-applications

Usage

Name Required Type Switches Description
skip number --skip, --s Enter the pagination skip
limit number --limit, --l Enter the pagination limit
sort string --sort, --x Enter the pagination sort JSON

Example

cloudcms platform list-applications  [--skip <skip>] [--limit <limit>] [--sort <sort>]

list-domains

Usage

Name Required Type Switches Description
skip number --skip, --s Enter the pagination skip
limit number --limit, --l Enter the pagination limit
sort string --sort, --x Enter the pagination sort JSON

Example

cloudcms platform list-domains  [--skip <skip>] [--limit <limit>] [--sort <sort>]

list-jobs

Usage

Name Required Type Switches Description
state string --state, --s The state of the job ('RUNNING', 'FINISHED', 'ERROR', 'WAITING', 'AWAITING')

Example

cloudcms platform list-jobs  [--state <state>]

list-projects

Usage

Name Required Type Switches Description
skip number --skip, --s Enter the pagination skip
limit number --limit, --l Enter the pagination limit
sort string --sort, --x Enter the pagination sort JSON

Example

cloudcms platform list-projects  [--skip <skip>] [--limit <limit>] [--sort <sort>]

list-repositories

Usage

Name Required Type Switches Description
skip number --skip, --s Enter the pagination skip
limit number --limit, --l Enter the pagination limit
sort string --sort, --x Enter the pagination sort JSON

Example

cloudcms platform list-repositories  [--skip <skip>] [--limit <limit>] [--sort <sort>]

query-applications

Usage

Name Required Type Switches Description
query string --query, --q Enter the query JSON
skip number --skip, --s Enter the pagination skip
limit number --limit, --l Enter the pagination limit
sort string --sort, --x Enter the pagination sort JSON

Example

cloudcms platform query-applications  [--query <query>] [--skip <skip>] [--limit <limit>] [--sort <sort>]

query-projects

Usage

Name Required Type Switches Description
query string --query, --q Enter the query JSON
skip number --skip, --s Enter the pagination skip
limit number --limit, --l Enter the pagination limit
sort string --sort, --x Enter the pagination sort JSON

Example

cloudcms platform query-projects  [--query <query>] [--skip <skip>] [--limit <limit>] [--sort <sort>]

query-repositories

Usage

Name Required Type Switches Description
query string --query, --q Enter the query JSON
skip number --skip, --s Enter the pagination skip
limit number --limit, --l Enter the pagination limit
sort string --sort, --x Enter the pagination sort JSON

Example

cloudcms platform query-repositories  [--query <query>] [--skip <skip>] [--limit <limit>] [--sort <sort>]

read-job

Usage

Name Required Type Switches Description
id required string --id Enter the job ID

Example

cloudcms platform read-job  --id <id>

read-repository

Usage

Name Required Type Switches Description
repositoryId required string --repository, --r Enter the repository ID

Example

cloudcms platform read-repository  --repository <repositoryId>

watch-job

Usage

Name Required Type Switches Description
jobId required string --jobId, --id Enter the job ID

Example

cloudcms platform watch-job  --jobId <jobId>

project

export

Usage

Name Required Type Switches Description
projectId required string --projectId, --project, --id The ID of the project
group required string --group, --g The group ID of the archive that should be exported
artifact required string --artifact, --a The artifact ID of the archive that should be exported
version required string --version, --v The version of the archive that should be exported

Example

cloudcms project export  --projectId <projectId> --group <group> --artifact <artifact> --version <version>

info

Usage

Name Required Type Switches Description
projectId required string --project, --p Enter the project ID

Example

cloudcms project info  --project <projectId>

list

Usage

Name Required Type Switches Description
skip number --skip, --s Enter the pagination skip
limit number --limit, --l Enter the pagination limit
sort string --sort, --x Enter the pagination sort JSON

Example

cloudcms project list  [--skip <skip>] [--limit <limit>] [--sort <sort>]

query

Usage

Name Required Type Switches Description
query string --query, --q Enter the query JSON
skip number --skip, --s Enter the pagination skip
limit number --limit, --l Enter the pagination limit
sort string --sort, --x Enter the pagination sort JSON

Example

cloudcms project query  [--query <query>] [--skip <skip>] [--limit <limit>] [--sort <sort>]

read

Usage

Name Required Type Switches Description
projectId required string --project, --p Enter the project ID

Example

cloudcms project read  --project <projectId>

publishing

resync

Usage

Name Required Type Switches Description
repositoryId required string --repository, --r Enter the repository ID
branchId required string --branch, --b Enter the branch ID
nodeId string --node, --id Enter a node ID
state string --state Enter a lifecycle state
config string --config Optional JSON configuration string

Example

cloudcms publishing resync  --repository <repositoryId> --branch <branchId> [--node <nodeId>] [--state <state>] [--config <config>]

repository

create-snapshot

Usage

Name Required Type Switches Description
repositoryId required string --repository, --r Enter the repository ID
changesetId required string --changeset, --c, --root Enter the root changeset ID

Example

cloudcms repository create-snapshot  --repository <repositoryId> --changeset <changesetId>

list-branches

Usage

Name Required Type Switches Description
repositoryId required string --repository, --r Enter the repository ID
skip number --skip, --s Enter the pagination skip
limit number --limit, --l Enter the pagination limit
sort string --sort, --x Enter the pagination sort JSON

Example

cloudcms repository list-branches  --repository <repositoryId> [--skip <skip>] [--limit <limit>] [--sort <sort>]

list-changesets

Usage

Name Required Type Switches Description
repositoryId required string --repository, --r Enter the repository ID
skip number --skip, --s Enter the pagination skip
limit number --limit, --l Enter the pagination limit
sort string --sort, --x Enter the pagination sort JSON

Example

cloudcms repository list-changesets  --repository <repositoryId> [--skip <skip>] [--limit <limit>] [--sort <sort>]

list-snapshots

Usage

Name Required Type Switches Description
repositoryId required string --repository, --r Enter the repository ID
skip number --skip, --s Enter the pagination skip
limit number --limit, --l Enter the pagination limit
sort string --sort, --x Enter the pagination sort JSON

Example

cloudcms repository list-snapshots  --repository <repositoryId> [--skip <skip>] [--limit <limit>] [--sort <sort>]

query-branches

Usage

Name Required Type Switches Description
repositoryId required string --repository, --r Enter the repository ID
query string --query, --q Enter the query JSON
skip number --skip, --s Enter the pagination skip
limit number --limit, --l Enter the pagination limit
sort string --sort, --x Enter the pagination sort JSON

Example

cloudcms repository query-branches  --repository <repositoryId> [--query <query>] [--skip <skip>] [--limit <limit>] [--sort <sort>]

query-changesets

Usage

Name Required Type Switches Description
repositoryId required string --repository, --r Enter the repository ID
query string --query, --q Enter the query JSON
skip number --skip, --s Enter the pagination skip
limit number --limit, --l Enter the pagination limit
sort string --sort, --x Enter the pagination sort JSON

Example

cloudcms repository query-changesets  --repository <repositoryId> [--query <query>] [--skip <skip>] [--limit <limit>] [--sort <sort>]

read-branch

Usage

Name Required Type Switches Description
repositoryId required string --repository, --r Enter the repository ID
branchId required string --branch, --b Enter the branch ID

Example

cloudcms repository read-branch  --repository <repositoryId> --branch <branchId>

read-changeset

Usage

Name Required Type Switches Description
repositoryId required string --repository, --r Enter the repository ID
changesetId required string --changeset, --c Enter the changeset ID

Example

cloudcms repository read-changeset  --repository <repositoryId> --changeset <changesetId>

sample

connect

Usage

Name Required Type Switches Description
out string --out, --o The output file path

Example

cloudcms sample connect  [--out <out>]

server

start

Example

cloudcms server start

tools

find-duplicate-qnames

Usage

Name Required Type Switches Description
repositoryId required string --repository, --r Enter the repository ID
branchId required string --branch, --b Enter the branch ID

Example

cloudcms tools find-duplicate-qnames  --repository <repositoryId> --branch <branchId>

transfer

export

Usage

Name Required Type Switches Description
source required string --source, --s The reference for a source object or datastore that should be exported.
group required string --group, --g The group ID of the exported archive.
artifact required string --artifact, --a The artifact ID of the exported archive.
version required string --version, --v The version of the exported archive.
vault boolean --vault The ID of the vault that will received the exported archive. If not specified, the "primary" vault will be used.
includeACLs boolean --includeACLs, --includeAcls Whether to include access control assignments for exported items
includeTeams boolean --includeTeams Whether to include teams (for any exported items that support them)
includeTeamMembers boolean --includeTeamMembers Whether to include members (principals) for any exported teams
includeRoles boolean --includeRoles Whether to include any custom roles that are defined against an exported data store.
includeActivities boolean --includeActivities Whether to include any activity reports for a given exported item.
includeBinaries boolean --includeBinaries Whether to include any binary files that are stored within an exported data store.
includeAttachments boolean --includeAttachments Whether to include any binary attachments that are stored on an attachable exported item.
startDate string --startDate The lower bound modification date for any exported items - specified as a date string or epoch time format.
endDate string --endDate The upper bound modification date for any exported items - specified as a date string or epoch time format.
startChangeset string --startChangeset Specifies a lower limit changeset ID for any exported repository changesets.
endChangeset string --endChangeset Specifies an upper limit changeset ID for any exported repository changesets.
selectedBranchId string --selectedBranchId, --selectedBranch For project or repository exports, specifies a branch that should be exported. If not provided, all branches are exported.
tipChangesetOnly boolean --tipChangesetOnly, --tipchangesetonly When exporting only a single branch, allows the branch contents to be compressed into a single changeset, resulting in a smaller archive.
contentIncludeFolders boolean --contentIncludeFolders When exporting nodes, whether to walk those nodes to include any parental folder hierarchies.
contentIncludeRelators boolean --contentIncludeRelators Forces the export of all relator property associations (and related content) even if those associations are linked.
branchIncludeRootChangeset boolean --branchIncludeRootChangeset When exporting branches, forces the export of the root changeset of the branch. If not specified, the root is not included.

Example

cloudcms transfer export  --source <source> --group <group> --artifact <artifact> --version <version> [--vault] [--includeACLs] [--includeTeams] [--includeTeamMembers] [--includeRoles] [--includeActivities] [--includeBinaries] [--includeAttachments] [--startDate <startDate>] [--endDate <endDate>] [--startChangeset <startChangeset>] [--endChangeset <endChangeset>] [--selectedBranchId <selectedBranchId>] [--tipChangesetOnly] [--contentIncludeFolders] [--contentIncludeRelators] [--branchIncludeRootChangeset]

import

Usage

Name Required Type Switches Description
target required string --target, --t The reference to the datastore you wish to conain the imported archive
group required string --group, --g The group ID of the archive that should be imported
artifact required string --artifact, --a The artifact ID of the archive that should be exported
version required string --version, --v The version of the archive that should be exported
vault boolean --vault, --vaultId The ID of the vault that will received the exported archive
strategy string --strategy, --s The strategy to use for import. Valid values are COPY_EVERYTHING, CLONE, COPY_TOP. Default is COPY_EVERYTHING
includeACLs boolean --includeACLs, --includeAcls undefined
includeTeams boolean --includeteams undefined
includeTeamMembers boolean --includeTeamMembers undefined
includeRoles boolean --includeRoles undefined
includeActivities boolean --includeActivities undefined
includeBinaries boolean --includeBinaries undefined
includeAttachments boolean --includeAttachments undefined
childrenOnly boolean --childrenOnly undefined
dryRun boolean --dryRun undefined
copyOnExisting boolean --copyOnExisting undefined
requireAllIncludes boolean --requireAllIncludes undefined
autoCleanup boolean --autoCleanup undefined
autoPublish boolean --autoPublish undefined

Example

cloudcms transfer import  --target <target> --group <group> --artifact <artifact> --version <version> [--vault] [--strategy <strategy>] [--includeACLs] [--includeteams] [--includeTeamMembers] [--includeRoles] [--includeActivities] [--includeBinaries] [--includeAttachments] [--childrenOnly] [--dryRun] [--copyOnExisting] [--requireAllIncludes] [--autoCleanup] [--autoPublish]

upgrade

apply

Usage

Name Required Type Switches Description
username required string --username, --u Admin username
password required string --password, --p Admin password

Example

cloudcms upgrade apply  --username <username> --password <password>

check

Usage

Name Required Type Switches Description
username required string --username, --u Admin username
password required string --password, --p Admin password

Example

cloudcms upgrade check  --username <username> --password <password>

vault

list-archives

Usage

Name Required Type Switches Description
vaultId required string --vault, --v, --id Enter the vault ID
skip number --skip, --s Enter the pagination skip
limit number --limit, --l Enter the pagination limit
sort string --sort, --x Enter the pagination sort JSON

Example

cloudcms vault list-archives  --vault <vaultId> [--skip <skip>] [--limit <limit>] [--sort <sort>]