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

To get started, you need to install Node.js on your development laptop and then use NPM to install the command-line client.

Step 1: Install Node.js

Visit http://www.nodejs.org and pick an installation package that is suitable for your operating system. Run the installer and pick all the default options. You're all set!

Step 2: Install the Cloud CMS command-line client

Once Node.js has been installed, you should open up a terminal window to drop into the command line. And then run,

npm install cloudcms-cli -g

Step 3: Connect to Cloud CMS

You should now connect your Cloud CMS tenant. Run the following:

cloudcms init

And walk through the prompts and provide your domain name, username and password, like this:

To get your Cloud CMS client keys and login credentials,
   visit "https://www.cloudcms.com".

Enter your Cloud CMS URL or subdomain: mydomain.cloudcms.net
Enter your Username: username
Enter your Password: password

Testing connectivity...
Successfully connected to Cloud CMS!

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

List of Commands

To pull up a list of commands, run:

cloudcms

And you will see:

    Cloud CMS command line tool

    Usage: cloudcms [command]

    Commands:

      init                 Configures your Cloud CMS command line client

    Application:
      create               Creates and connects the local app to a new Cloud CMS Application
      connect              Connects the local app to an existing Cloud CMS Application

    Content:
      install              Installs packaged content into the local app
      uninstall            Uninstalls packaged content from the local app

    Archives:
      package              Packages an archive from data on disk
      upload               Uploads an archive to Cloud CMS
      download             Downloads an archive from Cloud CMS to disk
      dependencies         Displays the dependencies for an archive

    Transfer:
      import               Imports an archive into the master branch
      export               Exports the master branch to an archive

    Hosting:
      deploy               Deploys the local app to the cloud
      undeploy             Undeploys the local app from the cloud
      start                Manually starts a deployed cloud app, making it live
      stop                 Manually stops a deployed cloud app, taking it offline
      info                 Retrieves information for a deployed cloud app
      open                 Launches the deployed cloud app in a browser

    Testing:
      server               Starts the Cloud CMS app server

    UI Addons:
      addon-register       Registers a user interface addon
      addon-unregister     Unregisters a user interface addon
      addon-list           Lists the registered addons
      addon-deploy         Deploys an addon to the user interface
      addon-undeploy       Undeploys an addon from the user interface
      addon-redeploy       Redeploys an addon to the user interface

    Diagnostic Tests
      test-api-latency     Reports on latency to the Cloud CMS API
      test-ui-latency      Reports on latency to the Cloud CMS User Interface
      test-latency <url>   Reports on unauthenticated latency to a given URL

    Options:

      -h, --help     output usage information
      -v, --version  output the version number

For more information on the command line tool, please visit the Cloud CMS - Command Line Tool Developer Page.