Go Ruby Shell Batchfile Makefile Inno Setup
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github Update Contributing Page W/ New Links [#158580002] Jul 31, 2018
actor continue version refactor from the previous few commits Aug 17, 2018
api add methods to get UAA links and version to UAA client Aug 18, 2018
bin clean up pull request tests Jun 11, 2018
cf rename and reorganize version constants Aug 17, 2018
ci switch pipeline to use master branch Aug 15, 2018
command continue version refactor from the previous few commits Aug 17, 2018
fixtures bump sinatra gem for integration assets Jun 6, 2018
i18n/resources whoops, forgot to commit this Mar 6, 2018
integration Stop matching on external error message text Aug 17, 2018
plugin change "Context" to "When" Aug 15, 2018
strings remove app-ports code Aug 2, 2018
types change "Context" to "When" Aug 15, 2018
util change "Context" to "When" Aug 15, 2018
vendor update golang.org/x packages Jul 12, 2018
version change "Context" to "When" Aug 15, 2018
.codeclimate.yml update config to version 2 Dec 26, 2017
.gitallowed Switch to gometalinter Jun 3, 2016
.gitattributes Commit i18n_resources.go Dec 15, 2015
.gitignore fix .gitignore file to only ignore those specific files Mar 30, 2018
.travis.yml travis should just use the same make we run regularly May 9, 2018
BUILD_VERSION Bump version to 6.38.0 Jul 23, 2018
Gopkg.lock update golang.org/x packages Jul 12, 2018
Gopkg.toml stop using branch Apr 19, 2018
LICENSE revert to full license (incl. appendix) Jan 11, 2017
Makefile change v3-app output Jul 6, 2018
NOTICE updated as per Chip's instructions Oct 21, 2016
README.md Add note about bash-completion requirement Jul 12, 2018
lintdebt Update lint debt Aug 31, 2016
main.go implemented switching logic between v3 and v2 app commands Jul 12, 2018

README.md

Getting Started | Download | Known Issues | Bugs/Feature Requests | Plugin Development | Contributing

CF logo

Cloud Foundry CLI

GitHub version Documentation Command help pages Slack License

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.

Note: CF CLI supports as far back as CF Release v251 (CAPI Release: 1.15.0 (APIs 2.69.0 and 3.4.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.

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.

Getting Started

Download and install the cf CLI from the Downloads Section.

Once installed, you can log in and push an app.

Example

Check out our community contributed CLI plugins to further enhance your CLI experience.

Downloads

Installing using a package manager

Mac OS X and Linux using Homebrew via the cloudfoundry tap:

brew install cloudfoundry/tap/cf-cli

Note: 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
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 --version

Edge binaries

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.

Known Issues

  • In Cygwin and Git Bash on Windows, interactive password prompts (in cf login) do not work (issue #171). Please use alternative commands (cf api and cf auth to cf login) to work around this.
  • On Windows, cf ssh may not display correctly if the TERM is not set. We've found that setting TERM to msys fixes some of these issues.
  • CF CLI/GoLang do not use OpenSSL. Custom/Self Signed Certificates need to be installed in specific locations in order to login/auth without --skip-ssl-validation.
  • API tracing to terminal (using CF_TRACE=true, -v option or cf config --trace) doesn't work well with some CLI plugin commands. Trace to file works fine. On Linux, CF_TRACE=/dev/stdout works too. See this Diego-Enabler plugin issue for more information.
  • .cfignore used in cf push must 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.

Plugin Development

For development guide on writing a cli plugin, see here.

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.