The official command line client for Cloud Foundry
Go Other
Latest commit aeab7a4 Apr 24, 2017 @pivotal-stuart-pollock pivotal-stuart-pollock committed with XenoPhex add ykk as a vendored package
[#142170163]

Signed-off-by: Anand Gaitonde <agaitonde@pivotal.io>
Permalink
Failed to load latest commit information.
.github update contributing document to go 1.8 Apr 20, 2017
actor unbind-security-group refactor Apr 24, 2017
api unbind-security-group refactor Apr 24, 2017
bin parallelized plugins integrations tests Apr 19, 2017
cf unbind-security-group refactor Apr 24, 2017
ci migrate skip flag with integration/plugins test Apr 19, 2017
command unbind-security-group refactor Apr 24, 2017
fixtures deleted loggregator endpoint from config Jan 27, 2017
githooks git hook to prevent pushing commits with anonymous Pivotal user Dec 5, 2016
integration added `RunIfExperimental` to unbind-security-group integration tests Apr 24, 2017
plugin remove offending plugin and update related docs Apr 19, 2017
strings create and bind routes in Apply Apr 21, 2017
util added --outdated flag to plugins command Apr 20, 2017
vendor add ykk as a vendored package Apr 24, 2017
version set binary version, sha and build date from ldflags Jan 10, 2017
.codeclimate.yml Enable codeclimate analysis Jun 1, 2016
.gitallowed Switch to gometalinter Jun 3, 2016
.gitattributes Commit i18n_resources.go Dec 15, 2015
.gitignore display CF icon on windows executables Jan 12, 2017
.travis.yml use go 1.8 on Travis Apr 20, 2017
CHANGELOG.md Fix broken Markdown headings Apr 17, 2017
LICENSE revert to full license (incl. appendix) Jan 11, 2017
NOTICE updated as per Chip's instructions Oct 21, 2016
README.md fixed rendering row under table Mar 22, 2017
lintdebt Update lint debt Aug 31, 2016
main.go unbind-security-group refactor Apr 24, 2017

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 Code Climate

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.

Getting Started

Download and install the cf CLI from the Downloads Section.

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

$ cf login -a api.[my-cloudfoundry].com
API endpoint: https://api.[my-cloudfoundry].com

Email> [my-email]

Password> [my-password]
Authenticating...
OK

$ cd [my-app-directory]
$ cf push

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

Downloads

Installing using a package manager

Mac OS X (using Homebrew via the cloudfoundry tap):

brew install cloudfoundry/tap/cf-cli

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 http://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://cli.run.pivotal.io/stable?release=macosx64-binary&source=github" | tar -zx
# ...or Linux 64-bit binary
curl -L "https://cli.run.pivotal.io/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 (see issue #171). Please use alternative commands (cf api and cf auth to cf login) to work around this.
  • 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 e.g. this Diego-Enabler plugin issue.
  • .cfignore used in cf push must 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 http://askubuntu.com/questions/133389/no-such-file-or-directory-but-the-file-exists

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.