Getting Started | Download | Known Issues | Bugs/Feature Requests | Plugin Development | Contributing
Cloud Foundry CLI is the official command line client for Cloud Foundry.
Latest help of each command is here (or run cf help);
Further documentation is at the docs page for the
CLI.
If you have any questions, ask away on the #cli channel in our Slack community and the cf-dev mailing list, or open a GitHub issue. You can follow our development progress on Pivotal Tracker.
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.
Mac OS X and Linux using Homebrew via the cloudfoundry tap:
brew install cloudfoundry/tap/cf-cliDebian 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-cliEnterprise 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| Mac OS X 64 bit | Windows 64 bit | Linux 64 bit | |
|---|---|---|---|
| Installers | pkg | zip | rpm / deb |
| Binaries | tgz | zip | tgz |
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 --versionEdge 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.
- In Cygwin and Git Bash on Windows, interactive password prompts (in
cf login) do not work (see issue #171). Please use alternative commands (cf apiandcf authtocf login) to work around this. - API tracing to terminal (using
CF_TRACE=true,-voption orcf config --trace) doesn't work well with some CLI plugin commands. Trace to file works fine. On Linux,CF_TRACE=/dev/stdoutworks too. See e.g. this Diego-Enabler plugin issue. - .cfignore used in
cf pushmust be in UTF8 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. See https://askubuntu.com/questions/133389/no-such-file-or-directory-but-the-file-exists
- Using non-refactored commands with verbose mode turned on will display the refresh token in the terminal.
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.
For development guide on writing a cli plugin, see here.
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.