---
title: "Commands"
description: "Enhance your command line experience with Cloud CMS, explore powerful root, admin, and application commands to optimize your workflow. (Gitana 4.0)"
product: "Gitana"
version: "4.0"
url: "/documentation/gitana/4.0/developers/cli/commands"
---

# Commands

The following commands are available:

## Root Commands

### init

Initializes your command line client's connection to Cloud CMS

#### Usage

| Name | Required | Type | Switches | Description |
| --- | --- | --- | --- | --- |
| ui | required | string | \--ui | The URL to your Cloud CMS UI endpoint (example: [https://mytenant.cloudcms.net](https://mytenant.cloudcms.net "https://mytenant.cloudcms.net") or [http://localhost](http://localhost "http://localhost")) |
| api | required | string | \--api, --a | The URL to your Cloud CMS API endpoint (example: [https://api.cloudcms.com](https://api.cloudcms.com "https://api.cloudcms.com") or [http://localhost:8080](http://localhost:8080 "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

Admin Commands

### fix-branch-tip

Fixes a branch tip.

#### Usage

| Name | Required | Type | Switches | Description |
| --- | --- | --- | --- | --- |
| repositoryId | required | string | \--repository, --r | Enter the repository ID |
| branchId | required | string | \--branch, --b | Enter the branch ID |
| commit |  | boolean | \--commit | Whether to commit a fix |
| tip |  | string | \--tip | Force to specific changeset ID |
| buildView |  | boolean | \--buildView | Whether to rebuild the branch view |

#### Example

```
cloudcms admin fix-branch-tip  --repository <repositoryId> --branch <branchId> [--commit] [--tip <tip>] [--buildView]
```

### get-cluster-healthcheck

Retrieves healthcheck information for members of a cluster

#### 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

Retrieves stats for members of a cluster

#### 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

Retrieves thread dump information for members of a cluster

#### 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

Gets all cluster configuration 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

Retrieves information about the cluster job queue

#### 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>
```

### healthcheck

Runs a diagnostic healthcheck against the API

#### Usage

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

#### Example

```
cloudcms admin healthcheck  --username <username> --password <password>
```

### import-platform-datastore

Imports a datastore to a platform after mongorestore

#### 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

Inspects a 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

Kills a 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

Kills cluster jobs in a given state

#### 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

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

Hands back a list of datastores which were deleted but remain on disk within MongoDB

#### 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

Lists the datastore 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

Migrates a datastore from one environment to another

#### 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

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

Reads a 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

Reads details about an 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

Refreshes all DB connections so that any old or stale connections are dropped and active ones are recreated

#### 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

Rebuilds MongoDB indexes for a 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

Runs repair operations over a branch to ensure any inconsistencies are detected or automatically fixed

#### 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, relators, badChildAssociationQNames, incorrectQNames, incorrectAttachments) |
| 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

Sets a key/value onto the cluster config

#### 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

Synchronizes the anchor snapshots for a repository

#### 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

Runs validation checks against a branch and reports any findings

#### 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

Application Commands

### download-api-keys

Download the API Keys for an application deployment

#### 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

Archive Commands

### download

Download an Archive

#### Usage

| Name | Required | Type | Switches | Description |
| --- | --- | --- | --- | --- |
| vaultId |  | string | \--vault | 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

Upload an Archive

#### Usage

| Name | Required | Type | Switches | Description |
| --- | --- | --- | --- | --- |
| vaultId |  | string | \--vault | 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

Branch Commands

### build-view

Rebuilds the tip view for a 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 branch build-view  --repository <repositoryId> --branch <branchId>
```

### create-node

Creates a 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

Creates the path index for a given 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 branch create-path-index  --repository <repositoryId> --branch <branchId>
```

### create-search-index

Creates the search index for a given 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 branch create-search-index  --repository <repositoryId> --branch <branchId>
```

### delete-path-index

Deletes the path index for a given 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 branch delete-path-index  --repository <repositoryId> --branch <branchId>
```

### delete-search-index

Deletes the search index for a given 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 branch delete-search-index  --repository <repositoryId> --branch <branchId>
```

### export

Exports a branch to an archive

#### 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

Gets the search index for a given 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 branch get-search-index  --repository <repositoryId> --branch <branchId>
```

### import

Imports an archive into a branch

#### 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>
```

### ingest

Ingests one or more streams

#### Usage

| Name | Required | Type | Switches | Description |
| --- | --- | --- | --- | --- |
| repositoryId | required | string | \--repository, --r | Enter the repository ID |
| branchId | required | string | \--branch, --b | Enter the branch ID |
| file | required | string | \--file, --f | Path to the source file |
| config |  | string | \--config, --c | Enter the object JSON |

#### Example

```
cloudcms branch ingest  --repository <repositoryId> --branch <branchId> --file <file> [--config <config>]
```

### list-definitions

Lists the definitions on the branch

#### 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

Queries for 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

Reads a 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

Rebases a branch to a new root changeset.

#### 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

Recreates all filenames from the title of nodes on a given 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 branch recreate-filenames  --repository <repositoryId> --branch <branchId>
```

### reset

Resets the tip changeset of a 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 |
| tipChangesetId | required | string | \--tip, --changeset, --c | Enter the new tip changeset ID |

#### Example

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

### revert

Reverts a branch back to the state described by a previous changeset.

#### 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

Searches for 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

Runs validation checks against all nodes on a branch and reports any findings

#### 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

Validates the search index for a given 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 |
| repair |  | boolean | \--repair | Automatically repair any discrepancies with the index |

#### Example

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

## datastore

Data Store Commands

### get-value

Gets a key/value from a datastore

#### 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

Reads a datastore

#### 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

Remove a key/value from a datastore

#### 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

Sets a key/value onto a datastore

#### 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

DB Admin Commands

### get-indexes

Gets the current set of DB indexes for a datastore

#### 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

Gets the set of system-managed DB indexes for a datastore

#### 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

Repairs DB indexes for a datastore

#### Usage

Comma-delimited regex string of paths to include (//) Comma-delimited regex string of paths to exclude (//)

#### Example

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

### validate-indexes

Validates DB indexes for a datastore

#### 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 | exclude |  | string | \--excludes, --exclude |
| username | required | string | \--username, --u | Admin username |  |  |  |
| password | required | string | \--password, --p | Admin password |  |  |  |

| 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

Deployment Commands

### find-deployment-records

Finds deployment records for a given 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 | required | string | \--node, --id | Enter a node ID |

#### Example

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

## domain

Domain Commands

### list-group-members

Lists the members of a group

#### 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

Lists the groups to which a principal belongs

#### 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

Lists the Principals in a Domain

#### 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

Queries for Principals in a Domain

#### 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

Reads a 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

File System Commands

### ls

Lists the files in the given path

#### 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

Hosted Application Commands

### deploy

Deploys an Application to hosting target

#### 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

Retrieve info about an Application deployment against a hosting target

#### 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

Opens the application deployment URL

#### 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

Restarts the deployed application

#### 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

Starts the deployed application

#### 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

Stops the deployed application

#### 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

Undeploys an Application from its hosting target

#### 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

Latency Commands

### server

Tests latency to any HTTP 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

Log File Commands

### download

Downloads the log file for your platform

#### Usage

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

#### Example

```
cloudcms log download  [--project <project>]
```

## module

Module Commands

### deploy

Deploys a Module

#### Usage

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

#### Example

```
cloudcms module deploy  --id <id>
```

### list

Lists the Modules

#### Example

```
cloudcms module list
```

### redeploy

Redeploys a Module

#### Usage

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

#### Example

```
cloudcms module redeploy  --id <id>
```

### register

Registers a Module

#### 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

Undeploys a Module

#### Usage

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

#### Example

```
cloudcms module undeploy  --id <id>
```

### unregister

Unregisters a Module

#### Usage

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

#### Example

```
cloudcms module unregister  --id <id>
```

## node

Node Commands

### children

Retrieves the children of a 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 |
| 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

Retrieves the relatives of a 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 |
| 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

Lists Versions of a 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 | 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

Patch Commands

### apply

Applies a patch to a datastore

#### 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

Lists the available patches in the cluster

#### 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

Platform Commands

### create-project

Creates a new 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 |
| strategy |  | string | \--strategy | Enter the strategy with which to import the source project |
| stackId |  | string | \--stackId, --stack | The existing stack to use |

#### Example

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

### create-repository

Creates a repository

#### Usage

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

#### Example

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

### delete-repository

Reads a Repository

#### Usage

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

#### Example

```
cloudcms platform delete-repository  --repository <repositoryId>
```

### get-jobs-summary

Retrieves a summary of the jobs waiting or executing in the job queue for the current platform

#### Example

```
cloudcms platform get-jobs-summary 
```

### info

Returns information about the current tenant platform

#### Example

```
cloudcms platform info 
```

### list-applications

Lists 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

Lists 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

Lists the jobs on your platform

#### 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

Lists 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

Lists 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>]
```

### list-stacks

Lists Stacks

#### 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-stacks  [--skip <skip>] [--limit <limit>] [--sort <sort>]
```

### query-applications

Queries for 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

Queries for 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

Queries for 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>]
```

### query-stacks

Queries for Stacks

#### 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-stacks  [--query <query>] [--skip <skip>] [--limit <limit>] [--sort <sort>]
```

### read-job

Reads a job for your platform

#### Usage

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

#### Example

```
cloudcms platform read-job  --id <id>
```

### read-repository

Reads a 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

Watches a job on your platform

#### Usage

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

#### Example

```
cloudcms platform watch-job  --jobId <jobId>
```

## project

Project Commands

### export

Exports a project to an archive

#### 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

Returns information about a project

#### Usage

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

#### Example

```
cloudcms project info  --project <projectId>
```

### read

Reads a project

#### Usage

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

#### Example

```
cloudcms project read  --project <projectId>
```

## publishing

Publishing Commands

### resync

Resyncs the publishing of one or more 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 |
| 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

Repository Commands

### create-snapshot

Creates a snapshot rooted at the given changeset ID.

#### 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>
```

### delete-branch

Deletes a branch

#### Usage

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

#### Example

```
cloudcms repository delete-branch  --repository <repositoryId> --branch <branchId>
```

### delete-snapshot

Deletes a snaphot

#### Usage

| Name | Required | Type | Switches | Description |
| --- | --- | --- | --- | --- |
| repositoryId | required | string | \--repository, --r | Enter the repository ID |
| snapshotId | required | string | \--snapshot, --s, --id | Enter the snapshot ID |

#### Example

```
cloudcms repository delete-snapshot  --repository <repositoryId> --snapshot <snapshotId>
```

### list-branches

Lists 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

Lists the Changesets in a Repository

#### 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

Lists 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

Queries for 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

Queries for Changesets in a Repository

#### 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

Reads a branch

#### Usage

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

#### Example

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

### read-changeset

Reads a 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

Sample Project Commands

### connect

Connects to the Sample Project application and downloads a gitana.json file

#### Usage

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

#### Example

```
cloudcms sample connect  [--out <out>]
```

## server

Server Commands

### start

Starts the Application Server

#### Example

```
cloudcms server start
```

## stack

Stack Commands

### assign

Assigns a datastore to a stack

#### Usage

| Name | Required | Type | Switches | Description |
| --- | --- | --- | --- | --- |
| stackId | required | string | \--stackId, --stack | The ID of the project |
| key | required | string | \--key | The unique key for the assignment |
| datastoreTypeId | required | string | \--datastoreTypeId, --datastoreType, --type | The type of the data store |
| datastoreId | required | string | \--datastoreId, --datastore, --id | The ID of the data store |

#### Example

```
cloudcms stack assign  --stackId <stackId> --key <key> --datastoreTypeId <datastoreTypeId> --datastoreId <datastoreId>
```

### list-assignments

Lists the assignments for a stack

#### Usage

| Name | Required | Type | Switches | Description |
| --- | --- | --- | --- | --- |
| stackId | required | string | \--stack, --s, --id | Enter the stack ID |

#### Example

```
cloudcms stack list-assignments  --stack <stackId>
```

### read

Reads a stack

#### Usage

| Name | Required | Type | Switches | Description |
| --- | --- | --- | --- | --- |
| stackId | required | string | \--stack, --s, --id | Enter the stack ID |

#### Example

```
cloudcms stack read  --stack <stackId>
```

### read-assignment

Reads an assignment for a stack

#### Usage

| Name | Required | Type | Switches | Description |
| --- | --- | --- | --- | --- |
| stackId | required | string | \--stack, --s, --id | Enter the stack ID |
| key | required | string | \--key | The unique key for the assignment |

#### Example

```
cloudcms stack read-assignment  --stack <stackId> --key <key>
```

### unassign

Unassigns a datastore from a stack

#### Usage

| Name | Required | Type | Switches | Description |
| --- | --- | --- | --- | --- |
| stackId | required | string | \--stackId, --stack | The ID of the project |
| key | required | string | \--key, --k | Enter the key of the stack element: |

#### Example

```
cloudcms stack unassign  --stackId <stackId> --key <key>
```

## tools

Tools and Utilities Group

### find-duplicate-qnames

Finds any definition nodes that have duplicated 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>
```

### ping

Pings the API endpoint and retrieves timing information

#### Example

```
cloudcms tools ping 
```

## transfer

Transfer Import/Export Group

### export

Export an archive from source object(s) or datastore(s)

#### 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 receive 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. |
| optionalAssociationsIncludeTypes |  | string | \--includeAssociationType | Mark association type as non-optional so that its target will be traversed and included in the resulting archive |
| optionalAssociationsExcludeTypes |  | string | \--excludeAssociationType | Mark association type as excluded so that its target won't be traversed or included in the resulting archive |
| optionalAssociationsMaxDepth |  | number | \--associationMaxDepth | Max traversal depth when evaluating content graph for nodes to include in the archive |

#### 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] [--includeAssociationType <optionalAssociationsIncludeTypes>] [--excludeAssociationType <optionalAssociationsExcludeTypes>] [--associationMaxDepth <optionalAssociationsMaxDepth>]
```

### import

Import an archive into a referenced datastore

#### Usage

| Name | Required | Type | Switches | Description |
| --- | --- | --- | --- | --- |
| target | required | string | \--target, --t | The reference to the datastore you wish to contain 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 receive 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 |
| copyBinaries |  | boolean | \--copyBinaries | undefined |
| copyAttachments |  | boolean | \--copyAttachments | 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 |
| title |  | string | \--title | undefined |

#### Example

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

## upgrade

Upgrade Commands

### apply

Applies any necessary upgrade steps to a Cloud CMS installation

#### 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

Checks whether any upgrade steps are required for a Cloud CMS installation

#### 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

Vault Commands

### list-archives

Lists 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>]
```

### query-archives

Query Archives

#### Usage

| Name | Required | Type | Switches | Description |
| --- | --- | --- | --- | --- |
| vaultId | required | string | \--vault, --v, --id | Enter the vault 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 vault query-archives  --vault <vaultId> [--query <query>] [--skip <skip>] [--limit <limit>] [--sort <sort>]
```

## Further Reading
