This 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 run the installer for your platform 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.
Latest stable: Download the installer or compressed binary for your platform:
| Mac OS X 64 bit | Windows 64 bit | Linux 64 bit | |
|---|---|---|---|
| Installers | pkg | zip | rpm / deb |
| Binaries | tgz | zip | tgz |
From the command line: Download examples with curl for Mac OS X and Linux
# ...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
# ...and to confirm your cf CLI version
$ ./cf --version
cf version x.y.z-...
Via Homebrew: Install CF for OSX through Homebrew via the cloudfoundry tap:
$ brew tap cloudfoundry/tap
$ brew install cf-cli
Releases: 32 bit releases and information about all our releases can be found here.
Also, edge binaries are published for Mac OS X 64 bit, Windows 64 bit and Linux 64 bit with each new 'push' that passes though CI. These binaries are not intended for wider use; they're for developers to test new features and fixes as they are completed.
- In Cygwin and Git Bash on Windows, interactive prompts (such as in
cf login) do not work (see #171). Please use alternative commands (e.g.cf apiandcf authtocf login) or option-fto suppress the prompts. - .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 http://askubuntu.com/questions/133389/no-such-file-or-directory-but-the-file-exists
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.