Local Command Line Interface

Get the latest docs.

You are looking at documentation for an older release. Not what you want? Use the version selector on the top banner or click here.

The Cloudify Docker image comes with Cloudify CLI pre installed. This guide illustrates how to use Cloudify docker image as local CLI client.

Install local Docker image

Install Cloudify on your local desktop. Use the following steps to install Cloudify docker image on your local desktop.

For example:

> sudo docker run --name cfy_manager_local -d --restart unless-stopped -v /sys/fs/cgroup:/sys/fs/cgroup:ro --tmpfs /run --tmpfs /run/lock --security-opt seccomp:unconfined --cap-add SYS_ADMIN -p 80:80 -p 8000:8000 cloudifyplatform/community-cloudify-manager-aio:latest

Executing the Cloudify CLI outside your local Community or Premium docker image

To execute the Cloudify CLI from your desktop to your local docker image you can use the following command:

> docker exec -it <Cloudify docker image name> cfy <command>

For example to get the local manager status you can run the following command:

> docker exec -it cfy_manager_local cfy status

Running the CLI on your local Community or Premium docker image

Open an interactive shell on the manger using the following command

> docker exec -it <image name> /bin/sh

This command will open a shell on your manager instance. You can now run any of the CLI command directly (without the “docker exec” prefix)

> cfy <command>

For example:

> docker exec -it cfy_manager_local /bin/sh

On your image prompt run the following cli command

sh-4.2#> cfy status

Connect to a remote manager

This option will allow you to redirect the CLI to a remote Cloudify Manager

> cfy init
> cfy profiles use <your manager hostname / URL / IP> -u admin -p <the admin  password> --ssl
> cfy profiles set --manager-tenant default_tenant

For example:

> cfy init
> cfy profiles use http://manaager.yoursite.com -u admin -p admin --ssl
> cfy profiles set --manager-tenant default_tenant

Deploy your first service

To run your first example on your local docker image run the local hello world example. This example deploys an http deamon on on your docker instance. (The example doesn’t require any cloud credentials)

CLI Reference Guide

See the command line reference guide to learn how to deploy a new service, execute workflow, etc..

For more options on how to install the Cloudify CLI on Linux, Windows or Mac refer to the CLI installation guide.