cf-traverse

README

cf-traverse

cf-traverse is a Cloud Foundry CLI plugin for traversing the relationships within the Cloud Foundry API. For instance, getting the service offering from a given service instance name or GUID.

It was born out of the frustration of writing code for the same handful of API traversals every time they were needed. The goal is to make it easier to write scripts which work with the Cloud Foundry API to get data out.

Usage

cf traverse [SOURCE ENTITY TYPE] [RELATION] [SOURCE ENTITY IDENTIFIER] 

Traverse takes 3 arguments: the type of the source entity (e.g. service instance), the relation to find, and an identifier for the source entity. The table below shows all the supported source entities, relations, and what qualifies as an identifier

Source entity type	Source entity identifier	Relation
service_instance	A service instance guid, or service instance name
		space
		org
		plan
		service_offering
service_plan	A service plan guid
		instances_of
service_offering	A service offering guid, or service offering name
		instances_of

Installation

You can either

• install from a release by running cf install-plugin -f RELEASE_ASSET_URL
• install from source by running make install. You will need semver-cli installed