github.com/elopio/cli@v6.21.2-0.20160902224010-ea909d1fdb2f+incompatible/README.md (about) 1 # Cloud Foundry CLI [![Apache License 2.0](https://img.shields.io/github/license/cloudfoundry/cli.svg)](https://github.com/cloudfoundry/cli/blob/master/LICENSE) [![Build Status](https://travis-ci.org/cloudfoundry/cli.png?branch=master)](https://travis-ci.org/cloudfoundry/cli) [![Code Climate](https://codeclimate.com/github/cloudfoundry/cli/badges/gpa.svg)](https://codeclimate.com/github/cloudfoundry/cli) 2 3 This is the official command line client for [Cloud Foundry](https://cloudfoundry.org). 4 Latest help of each command is [here](https://cli.cloudfoundry.org) (or run `cf help`); 5 Further documentation is at the [docs page for the 6 CLI](https://docs.cloudfoundry.org/cf-cli). 7 8 If you have any questions, ask away on the #cli channel in [our Slack 9 community](http://slack.cloudfoundry.org/) and the 10 [cf-dev](https://lists.cloudfoundry.org/archives/list/cf-dev@lists.cloudfoundry.org/) 11 mailing list, or open a GitHub issue. You can follow our development progress 12 on [Pivotal Tracker](https://www.pivotaltracker.com/s/projects/892938). 13 14 ## Getting Started 15 16 Download and run the installer for your platform from the [Downloads Section](#downloads). 17 18 Once installed, you can log in and push an app. 19 ``` 20 $ cf login -a api.[my-cloudfoundry].com 21 API endpoint: https://api.[my-cloudfoundry].com 22 23 Email> [my-email] 24 25 Password> [my-password] 26 Authenticating... 27 OK 28 29 $ cd [my-app-directory] 30 $ cf push 31 ``` 32 33 Check out our [community contributed CLI plugins](https://plugins.cloudfoundry.org) to further enhance your CLI experience. 34 35 ## Downloads 36 37 **Latest stable:** Download the installer or compressed binary for your platform: 38 39 | | Mac OS X 64 bit | Windows 64 bit | Linux 64 bit | 40 | :---------------: | :---------------: |:---------------:| :------------:| 41 | Installers | [pkg](https://cli.run.pivotal.io/stable?release=macosx64&source=github) | [zip](https://cli.run.pivotal.io/stable?release=windows64&source=github) | [rpm](https://cli.run.pivotal.io/stable?release=redhat64&source=github) / [deb](https://cli.run.pivotal.io/stable?release=debian64&source=github) | 42 | Binaries | [tgz](https://cli.run.pivotal.io/stable?release=macosx64-binary&source=github) | [zip](https://cli.run.pivotal.io/stable?release=windows64-exe&source=github) | [tgz](https://cli.run.pivotal.io/stable?release=linux64-binary&source=github) | 43 44 **From the command line:** Download examples with curl for Mac OS X and Linux 45 ``` 46 # ...download & extract Mac OS X binary 47 $ curl -L "https://cli.run.pivotal.io/stable?release=macosx64-binary&source=github" | tar -zx 48 # ...or Linux 64-bit binary 49 $ curl -L "https://cli.run.pivotal.io/stable?release=linux64-binary&source=github" | tar -zx 50 # ...and to confirm your cf CLI version 51 $ ./cf --version 52 cf version x.y.z-... 53 ``` 54 55 **Via Homebrew:** Install CF for OSX through [Homebrew](http://brew.sh/) via the [cloudfoundry tap](https://github.com/cloudfoundry/homebrew-tap): 56 57 ``` 58 $ brew tap cloudfoundry/tap 59 $ brew install cf-cli 60 ``` 61 62 **Releases:** 32 bit releases and information about all our releases can be found [here](https://github.com/cloudfoundry/cli/releases). 63 64 Also, **edge binaries** are published for [Mac OS X 64 bit](https://cli.run.pivotal.io/edge?arch=macosx64&source=github), [Windows 64 bit](https://cli.run.pivotal.io/edge?arch=windows64&source=github) and [Linux 64 bit](https://cli.run.pivotal.io/edge?arch=linux64&source=github) with each new 'push' that passes though CI. 65 These binaries are *not intended for wider use*; they're for developers to test new features and fixes as they are completed. 66 67 ## Known Issues 68 69 * 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 api` and `cf auth` to `cf login`) or option `-f` to suppress the prompts. 70 * .cfignore used in `cf push` must be in UTF8 encoding for CLI to interpret correctly. 71 * 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 72 73 ## Filing Issues & Feature Requests 74 75 First, update to the [latest cli](https://github.com/cloudfoundry/cli/releases) 76 and try the command again. 77 78 If the error remains or feature still missing, check the [open issues](https://github.com/cloudfoundry/cli/issues) and if not already raised please file a new issue with the requested details. 79 80 ## Plugins 81 82 For development guide on writing a cli plugin, see [here](https://github.com/cloudfoundry/cli/tree/master/plugin_examples). 83 84 ## Contributing 85 86 Please read the [contributors' guide](CONTRIBUTING.md) 87 88 If you'd like to submit updated translations, please see the [i18n README](https://github.com/cloudfoundry/cli/blob/master/cf/i18n/README-i18n.md) for instructions on how to submit an update. 89