Cloud Foundry CLI
Important Note: CF CLI supports as far back as CF Release v284/CF Deployment v1.7.0 (CAPI Release: 1.46.0 (APIs 2.100.0 and 3.35.0). See our wiki for more information. If you are on an older version of CF Release, we recommend you upgrade to a supported version.
Download and install the cf CLI from the Downloads Section.
Once installed, you can log in and push an app.
Check out our community contributed CLI plugins to further enhance your CLI experience.
Installing using a package manager
brew install cloudfoundry/tap/cf-cli
cf tab completion requires
bash-completion to be installed properly in order to work.
Debian and Ubuntu based Linux distributions:
# ...first add the Cloud Foundry Foundation public key and package repository to your system wget -q -O - https://packages.cloudfoundry.org/debian/cli.cloudfoundry.org.key | sudo apt-key add - echo "deb https://packages.cloudfoundry.org/debian stable main" | sudo tee /etc/apt/sources.list.d/cloudfoundry-cli.list # ...then, update your local package index, then finally install the cf CLI sudo apt-get update sudo apt-get install cf-cli
Enterprise Linux and Fedora systems (RHEL6/CentOS6 and up):
# ...first configure the Cloud Foundry Foundation package repository sudo wget -O /etc/yum.repos.d/cloudfoundry-cli.repo https://packages.cloudfoundry.org/fedora/cloudfoundry-cli.repo # ...then, install the cf CLI (which will also download and add the public key to your system) sudo yum install cf-cli
Installers and compressed binaries
|Mac OS X 64 bit||Windows 64 bit||Linux 64 bit|
|Installers||pkg||zip||rpm / deb|
Release notes, and 32 bit releases can be found here.
Download examples with curl for Mac OS X and Linux binaries
# ...download & extract Mac OS X binary curl -L "https://packages.cloudfoundry.org/stable?release=macosx64-binary&source=github" | tar -zx # ...or Linux 64-bit binary curl -L "https://packages.cloudfoundry.org/stable?release=linux64-binary&source=github" | tar -zx # ...move it to /usr/local/bin or a location you know is in your $PATH mv cf /usr/local/bin # ...copy tab completion file on Ubuntu (takes affect after re-opening your shell) sudo curl -o /usr/share/bash-completion/completions/cf https://raw.githubusercontent.com/cloudfoundry/cli/master/ci/installers/completion/cf # ...and to confirm your cf CLI version cf --version
Edge binaries are not intended for wider use; they're for developers to test new features and fixes as they are 'pushed' and passed through the CI. Follow these download links for Mac OS X 64 bit, Windows 64 bit and Linux 64 bit.
- On Windows in Cygwin and Git Bash, interactive password prompts (in
cf login) do not work (issue #171). Please use alternative commands (non-interactive authentification
cf apiinstead of
cf login) to work around this. Or, use the Windows
- On Windows,
cf sshmay not display correctly if the
TERMis not set. We've found that setting
msysfixes some of these issues.
- On Windows,
cf sshwill hang when run from the MINGW32 or MINGW64 shell. A workaround is to use PowerShell instead.
- CF CLI/GoLang do not use OpenSSL. Custom/Self Signed Certificates need to be installed in specific locations in order to
- API tracing to terminal (using
cf config --trace) doesn't work well with some CLI plugin commands. Trace to file works fine. On Linux,
CF_TRACE=/dev/stdoutworks too. See this Diego-Enabler plugin issue for more information.
- .cfignore used in
cf pushmust be in UTF-8 encoding for CLI to interpret correctly.
- On Linux, when encountering message "bash: .cf: No such file or directory", ensure that you're using the correct binary or installer for your architecture.
- Using non-refactored commands with verbose mode turned on will display the refresh token in the terminal.
Filing Issues & Feature Requests
First, update to the latest cli and try the command again.
If the error remains or feature still missing, check the open issues and if not already raised please file a new issue with the requested details.
The CF CLI supports external code execution via the plugins API. For more information follow:
When importing the plugin code use
Older plugins that import
github.com/cloudfoundry/cli/plugin will still work
as long they vendor the plugins directory.
Contributing & Build Instructions
Please read the contributors' guide
If you'd like to submit updated translations, please see the i18n README for instructions on how to submit an update.