Cloud Foundry Command Line Interface, version [5.4.7]
Use 'cf help [command]' for command details.
For docs and support visit http://support.cloudfoundry.com
USAGE EXAMPLES
$ cf target api.run.pivotal.io <-- sets the CF instance target where your app will be pushed
$ cf push <-- deploys app to current app space on current target
$ cf target -s staging <– changes currently targeted app space to 'staging'
Getting Started
login [EMAIL] Authenticate with the target
colors Show color configuration
logout Log out from the target
targets List known targets.
target [URL] Set or display the target cloud, organization, and space
Applications
app [APP] Show app information
apps List your applications
Management
push [NAME] Push an application, syncing changes if it exists
restart APPS... Stop and start an application
delete APPS... Delete an application
rename [APP] [NAME] Rename an application
start APPS... Start an application
stop APPS... Stop an application
console [APP] Open a console connected to your app
Information
health APPS... Get application health
stats [APP] Display application instance status
instances APPS... List an app's instances
logs [APP] Print out an app's logs
crashlogs APP Print out the logs for an app's crashed instances
env [APP] Show all environment variables set for an app
set-env APP NAME [VALUE] Set an environment variable
unset-env APP NAME Remove an environment variable
file APP [PATH] Print out an app's file contents
files APP [PATH] Examine an app's files
tail APP [PATH] Stream an app's file contents
scale [APP] Update the instances/memory limit for an application
events [APP] Display application events
map [APP] [HOST] DOMAIN Add a URL mapping
unmap [URL] [APP] Remove a URL mapping
Services
service SERVICE Show service information
services List your services
Management
unbind-service [SERVICE] [APP] Unbind a service from an application
bind-service [SERVICE] [APP] Bind a service to an application
delete-service [SERVICE] Delete a service
rename-service [SERVICE] [NAME] Rename a service
create-service [OFFERING] [NAME] Create a service
tunnel [INSTANCE] [CLIENT] Create a local tunnel to a service.
Organizations
org [ORGANIZATION] Show organization information
orgs List available organizations
delete-org [ORGANIZATION] Delete an organization
rename-org [ORGANIZATION] [NAME] Rename an organization
create-org [NAME] Create an organization
Spaces
switch-space NAME Switch to a space
spaces [ORGANIZATION] List spaces in an organization
delete-space SPACE Delete a space and its contents
rename-space [SPACE] [NAME] Rename a space
create-space [NAME] [ORGANIZATION] Create a space in an organization
space [SPACE] Show space information
Routes
routes List routes in a space
delete-route ROUTE Delete a route
Domains
domains [SPACE] List domains in a space
map-domain NAME Map a domain to an organization or space
unmap-domain DOMAIN Unmap a domain from an organization or space
Administration
users List all users
curl MODE PATH HEADERS… Execute a raw request
guid TYPE [NAME] Obtain guid of an object(s)
set-quota [QUOTA_DEFINITION] [ORGANIZATION] Change the quota definition for the given (or current) organization.
service-auth-tokens List service auth tokens
create-service-auth-token [LABEL] [PROVIDER] Create a service auth token
update-service-auth-token [SERVICE_AUTH_TOKEN] Update a service auth token
delete-service-auth-token [SERVICE_AUTH_TOKEN] Delete a service auth token
add-service-broker [NAME] Add a service broker
remove-service-broker NAME Remove a service broker
service-brokers List registered service brokers
update-service-broker BROKER [NAME] Update a service broker
User Management
passwd Update the current user's password
register [EMAIL] Create a user and log in
create-user [EMAIL] Create a user
Options:
--[no-]color Use colorful output
--[no-]script Shortcut for --quiet and --force
--debug Print full stack trace (instead of crash log)
--http-proxy HTTP_PROXY Connect with an http proxy server
--https-proxy HTTPS_PROXY Connect with an https proxy server
-V, –verbose Print extra information
-f, –[no-]force Skip interaction when possible
-h, –help Show command usage
-m, –manifest FILE Path to manifest file to use
-q, –[no-]quiet Simplify output format
-t, –trace Show API traffic
-v, –version Print version number