All apps/Cloud Foundry CLI

Cloud Foundry CLI

cf

The official command line client for Cloud Foundry.

Runs as cf|macOS, Linux, Windows|docs.cloudfoundry.org

Autocomplete

Fig spec, with what the manifest adds · 109 subcommands · 2 options
Published once and never changed; check the digest before caching
sha256
5dcc84e6645df5e75765c84e81a438cf42da94ac07a9e0f88cdfc6941208d629
Size
64213 bytes
Subcommands109 subcommands
cf app
Display health and status for app
cf ssh
Display health and status for app
cf env
Show all env variables for an app
cf orgs
List all orgs
cf version
Print the version of cf
cf login
Log user in
cf logout
Log user out
cf password
Change user password
cf target
Set or view the targeted org or space
cf api
Set or view target api url
cf auth
Auth user non-interactively
cf apps
List all apps in the target space
cf push
Push a new app or sync changes to an existing app
cf scale
Change or view the instance count, disk space limit, and memory limit for an app
cf delete
Delete an app
cf rename
Rename an app
cf start
Start an app
cf stop
Stop an app
cf restart
Stop all instances of the app, then start them again. This may cause downtime
cf restage
Recreate the app's executable artifact using the latest pushed app files and the latest environment (variables, service bindings, buildpack, stack, etc.)
cf restart-app-instance
Terminate the running application Instance at the given index and instantiate a new instance of the application with the same index
cf run-task
Run a one-off task on an app
cf tasks
List tasks of an app
cf terminate-task
Terminate a running task of an app
cf events
Show recent app events
cf files
Print out a list of files in a directory or the contents of a specific file of an app running on the DEA backend
cf logs
Trail or show recent logs for an app
cf set-env
Set an environment variable for an app
cf unset-env
Remove an environment variable
cf stacks
List all stacks (a stack is a pre-built file system, including an operating system, that can run apps)
cf copy-source
Copies the source code of an application to another existing application (and restarts that application)
cf create-app-manifest
Create an app manifest for an app that has been pushed successfully
cf get-health-check
Show the type of health check performed on an app
cf set-health-check
Change type of health check performed on an app
cf enable-ssh
Enable ssh for the application
cf disable-ssh
Disable ssh for the application
cf ssh-enabled
Reports whether SSH is enabled on an application container instance
cf marketplace
List available offerings in the marketplace
cf services
List all service instances in the target space
cf create-service
Create a service instance
cf update-service
Update a service instance
cf delete-service
Delete a service instance
cf rename-service
Rename a service instance
cf create-service-key
Create key for a service instance
cf service-keys
List keys for a service instance
cf service-key
Show service key info
cf delete-service-key
Delete a service key
cf bind-service
Bind a service instance to an app
cf unbind-service
Unbind a service instance from an app
cf bind-route-service
Bind a service instance to an HTTP route
cf unbind-route-service
Unbind a service instance from an HTTP route
cf create-user-provided-service
Make a user-provided service instance available to CF apps
cf update-user-provided-service
Update user-provided service instance
cf org
Show org info
cf create-org
Create an org
cf delete-org
Delete an org
cf rename-org
Rename an org
cf spaces
List all spaces in an org
cf space
Show space info
cf create-space
Create a space
cf delete-space
Delete a space
cf rename-space
Rename a space
cf allow-space-ssh
Allow SSH access for the space
cf disallow-space-ssh
Disallow SSH access for the space
cf space-ssh-allowed
Reports whether SSH is allowed in a space
cf domains
List domains in the target org
cf create-domain
Create a domain in an org for later use
cf delete-domain
Delete a domain
cf create-shared-domain
Create a domain that can be used by all orgs (admin-only)
cf delete-shared-domain
Delete a shared domain
cf router-groups
List router groups
cf routes
List all routes in the current space or the current organization
cf create-route
Create a url route in a space for later use
cf check-route
Perform a simple check to determine whether a route currently exists or not
cf map-route
Add a url route to an app
cf unmap-route
Remove a url route from an app
cf delete-route
Delete a route
cf delete-orphaned-routes
Delete all orphaned routes (i.e. those that are not mapped to an app)
cf create-user
Create a new user
cf delete-user
Delete a user
cf org-users
Show org users by role
cf set-org-role
Assign an org role to a user
cf unset-org-role
Remove an org role from a user
cf space-users
Show space users by role
cf set-space-role
Assign a space role to a user
cf unset-space-role
Remove a space role from a user
cf quotas
List available usage quotas
cf quota
Show quota info
cf set-quota
Assign a quota to an org
cf create-quota
Define a new resource quota
cf delete-quota
Delete a quota
cf update-quota
Update an existing resource quota
cf space-quotas
List available space resource quotas
cf space-quota
Show space quota info
cf create-space-quota
Define a new space resource quota
cf update-space-quota
Update an existing space quota
cf delete-space-quota
Delete a space quota definition and unassign the space quota from all spaces
cf set-space-quota
Assign a space quota definition to a space
cf unset-space-quota
Unassign a quota from a space
cf curl
Executes a request to the targeted API endpoint
cf oauth-token
Retrieve and display the OAuth token for the current session
cf ssh-code
Get a one time password for ssh clients
cf add-plugin-repo
Add a new plugin repository
cf remove-plugin-repo
Remove a plugin repository
cf list-plugin-repos
List all the added plugin repositories
cf repo-plugins
List all available plugins in specified repository or in all added repositories
cf plugins
List all available plugin commands
cf install-plugin
Install CLI plugin
cf uninstall-plugin
Uninstall the plugin defined in command argument
OptionsOn cf itself
--help-h
Show help for Cloud Foundry command line tool
-v
Print API request diagnostics to stdout