cf

Cloudfoundry cli

Subcommands

NameDescription
app, aDisplay health and status for app
sshDisplay health and status for app
envShow all env variables for an app
orgsList all orgs
version, -v, --versionPrint the version of cf
loginLog user in
logoutLog user out
passwordChange user password
targetSet or view the targeted org or space
apiSet or view target api url
authAuth user non-interactively
appsList all apps in the target space
pushPush a new app or sync changes to an existing app
scaleChange or view the instance count, disk space limit, and memory limit for an app
deleteDelete an app
renameRename an app
startStart an app
stopStop an app
restartStop all instances of the app, then start them again. This may cause downtime
restageRecreate the app's executable artifact using the latest pushed app files and the latest environment (variables, service bindings, buildpack, stack, etc.)
restart-app-instanceTerminate the running application Instance at the given index and instantiate a new instance of the application with the same index
run-taskRun a one-off task on an app
tasksList tasks of an app
terminate-taskTerminate a running task of an app
eventsShow recent app events
filesPrint out a list of files in a directory or the contents of a specific file of an app running on the DEA backend
logsTrail or show recent logs for an app
set-envSet an environment variable for an app
unset-envRemove an environment variable
stacksList all stacks (a stack is a pre-built file system, including an operating system, that can run apps)
copy-sourceCopies the source code of an application to another existing application (and restarts that application)
create-app-manifestCreate an app manifest for an app that has been pushed successfully
get-health-checkShow the type of health check performed on an app
set-health-checkChange type of health check performed on an app
enable-sshEnable ssh for the application
disable-sshDisable ssh for the application
ssh-enabledReports whether SSH is enabled on an application container instance
marketplaceList available offerings in the marketplace
services, sList all service instances in the target space
create-serviceCreate a service instance
update-serviceUpdate a service instance
delete-serviceDelete a service instance
rename-serviceRename a service instance
create-service-keyCreate key for a service instance
service-keysList keys for a service instance
service-keyShow service key info
delete-service-keyDelete a service key
bind-serviceBind a service instance to an app
unbind-serviceUnbind a service instance from an app
bind-route-serviceBind a service instance to an HTTP route
unbind-route-serviceUnbind a service instance from an HTTP route
create-user-provided-serviceMake a user-provided service instance available to CF apps
update-user-provided-serviceUpdate user-provided service instance
orgShow org info
create-orgCreate an org
delete-orgDelete an org
rename-orgRename an org
spacesList all spaces in an org
spaceShow space info
create-spaceCreate a space
delete-spaceDelete a space
rename-spaceRename a space
allow-space-sshAllow SSH access for the space
disallow-space-sshDisallow SSH access for the space
space-ssh-allowedReports whether SSH is allowed in a space
domainsList domains in the target org
create-domainCreate a domain in an org for later use
delete-domainDelete a domain
create-shared-domainCreate a domain that can be used by all orgs (admin-only)
delete-shared-domainDelete a shared domain
router-groupsList router groups
routesList all routes in the current space or the current organization
create-routeCreate a url route in a space for later use
check-routePerform a simple check to determine whether a route currently exists or not
map-routeAdd a url route to an app
unmap-routeRemove a url route from an app
delete-routeDelete a route
delete-orphaned-routesDelete all orphaned routes (i.e. those that are not mapped to an app)
create-userCreate a new user
delete-userDelete a user
org-usersShow org users by role
set-org-roleAssign an org role to a user
unset-org-roleRemove an org role from a user
space-usersShow space users by role
set-space-roleAssign a space role to a user
unset-space-roleRemove a space role from a user
quotasList available usage quotas
quotaShow quota info
set-quotaAssign a quota to an org
create-quotaDefine a new resource quota
delete-quotaDelete a quota
update-quotaUpdate an existing resource quota
space-quotasList available space resource quotas
space-quotaShow space quota info
create-space-quotaDefine a new space resource quota
update-space-quotaUpdate an existing space quota
delete-space-quotaDelete a space quota definition and unassign the space quota from all spaces
set-space-quotaAssign a space quota definition to a space
unset-space-quotaUnassign a quota from a space
curlExecutes a request to the targeted API endpoint
oauth-tokenRetrieve and display the OAuth token for the current session
ssh-codeGet a one time password for ssh clients
add-plugin-repoAdd a new plugin repository
remove-plugin-repoRemove a plugin repository
list-plugin-reposList all the added plugin repositories
repo-pluginsList all available plugins in specified repository or in all added repositories
pluginsList all available plugin commands
install-pluginInstall CLI plugin
uninstall-pluginUninstall the plugin defined in command argument

Options

NameDescription
--help, -hShow help for Cloud Foundry command line tool
-vPrint API request diagnostics to stdout