github.com/dcarley/cf-cli@v6.24.1-0.20170220111324-4225ff346898+incompatible/README.md (about)

     1  <p align="center">
     2  <b><a href="#getting-started">Getting Started</a></b>
     3  |
     4  <b><a href="#downloads">Download</a></b>
     5  |
     6  <b><a href="#known-issues">Known Issues</a></b>
     7  |
     8  <b><a href="#filing-issues--feature-requests">Bugs/Feature Requests</a></b>
     9  |
    10  <b><a href="#plugin-development">Plugin Development</a></b>
    11  |
    12  <b><a href="#contributing--build-instructions">Contributing</a></b>
    13  </p>
    14  
    15  <img src="https://raw.githubusercontent.com/cloudfoundry/logos/master/CF_Icon_4-colour.png" alt="CF logo" height="100" align="left"/>
    16  # Cloud Foundry CLI
    17  [![GitHub version](https://badge.fury.io/gh/cloudfoundry%2Fcli.svg)](https://github.com/cloudfoundry/cli/releases/latest)
    18  [![Documentation](https://img.shields.io/badge/docs-online-ff69b4.svg)](https://docs.cloudfoundry.org/cf-cli)
    19  [![Command help pages](https://img.shields.io/badge/command-help-lightgrey.svg)](https://cli.cloudfoundry.org)
    20  [![Slack](https://slack.cloudfoundry.org/badge.svg)](https://slack.cloudfoundry.org)
    21  [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/cloudfoundry/cli/blob/master/LICENSE)
    22  [![Code Climate](https://codeclimate.com/github/cloudfoundry/cli/badges/gpa.svg)](https://codeclimate.com/github/cloudfoundry/cli)
    23  
    24  ***Cloud Foundry CLI*** is the official command line client for [Cloud Foundry](https://cloudfoundry.org).
    25  Latest help of each command is [here](https://cli.cloudfoundry.org) (or run `cf help`);
    26  Further documentation is at the [docs page for the
    27  CLI](https://docs.cloudfoundry.org/cf-cli).  
    28  
    29  If you have any questions, ask away on the #cli channel in [our Slack
    30  community](http://slack.cloudfoundry.org/) and the
    31  [cf-dev](https://lists.cloudfoundry.org/archives/list/cf-dev@lists.cloudfoundry.org/)
    32  mailing list, or [open a GitHub issue](https://github.com/cloudfoundry/cli/issues/new).  You can follow our development progress
    33  on [Pivotal Tracker](https://www.pivotaltracker.com/s/projects/892938).
    34  
    35  ## Getting Started
    36  
    37  Download and install the cf CLI from the [Downloads Section](#downloads).
    38  
    39  Once installed, you can log in and push an app.
    40  ```sh
    41  $ cf login -a api.[my-cloudfoundry].com
    42  API endpoint: https://api.[my-cloudfoundry].com
    43  
    44  Email> [my-email]
    45  
    46  Password> [my-password]
    47  Authenticating...
    48  OK
    49  
    50  $ cd [my-app-directory]
    51  $ cf push
    52  ```
    53  
    54  Check out our [community contributed CLI plugins](https://plugins.cloudfoundry.org) to further enhance your CLI experience.
    55  
    56  ## Downloads
    57  
    58  ### Installing using a package manager
    59  
    60  **Mac OS X** (using [Homebrew](http://brew.sh/) via the [cloudfoundry tap](https://github.com/cloudfoundry/homebrew-tap)):
    61  
    62  ```sh
    63  $ brew tap cloudfoundry/tap
    64  $ brew install cf-cli
    65  ```
    66  
    67  **Debian** and **Ubuntu** based Linux distributions:
    68  
    69  ```sh
    70  # ...first add the Cloud Foundry Foundation public key and package repository to your system
    71  $ wget -q -O - https://packages.cloudfoundry.org/debian/cli.cloudfoundry.org.key | sudo apt-key add -
    72  $ echo "deb http://packages.cloudfoundry.org/debian stable main" | sudo tee /etc/apt/sources.list.d/cloudfoundry-cli.list
    73  # ...then, update your local package index, then finally install the cf CLI
    74  $ sudo apt-get update
    75  $ sudo apt-get install cf-cli
    76  ```
    77  
    78  **Enterprise Linux** and **Fedora** systems (RHEL6/CentOS6 and up):
    79  ```sh
    80  # ...first configure the Cloud Foundry Foundation package repository
    81  $ sudo wget -O /etc/yum.repos.d/cloudfoundry-cli.repo https://packages.cloudfoundry.org/fedora/cloudfoundry-cli.repo
    82  # ...then, install the cf CLI (which will also download and add the public key to your system)
    83  $ sudo yum install cf-cli
    84  ```
    85  
    86  ### Installers and compressed binaries
    87  
    88  | | Mac OS X 64 bit | Windows 64 bit | Linux 64 bit |
    89  | :---------------: | :---------------: |:---------------:| :------------:|
    90  | 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) |
    91  | 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) |
    92  Release notes, and 32 bit releases can be found [here](https://github.com/cloudfoundry/cli/releases).
    93  
    94  **Download examples** with curl for Mac OS X and Linux binaries
    95  ```sh
    96  # ...download & extract Mac OS X binary
    97  $ curl -L "https://cli.run.pivotal.io/stable?release=macosx64-binary&source=github" | tar -zx
    98  # ...or Linux 64-bit binary
    99  $ curl -L "https://cli.run.pivotal.io/stable?release=linux64-binary&source=github" | tar -zx
   100  # ...move it to /usr/local/bin or a location you know is in your $PATH
   101  $ mv cf /usr/local/bin
   102  # ...and to confirm your cf CLI version
   103  $ cf --version
   104  cf version x.y.z+...
   105  ```
   106  
   107  #### Edge binaries
   108  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.
   109  Follow these download links 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).
   110  
   111  ## Known Issues
   112  
   113  * In Cygwin and Git Bash on Windows, interactive password prompts (in `cf login`) do not work (see [issue #171](https://github.com/cloudfoundry/cli/issues/171)). Please use alternative commands (`cf api` and `cf auth` to `cf login`) to work around this.
   114  * 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](https://github.com/cloudfoundry-incubator/Diego-Enabler/issues/6).
   115  * .cfignore used in `cf push` must be in UTF8 encoding for CLI to interpret correctly.
   116  * 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
   117  
   118  ## Filing Issues & Feature Requests
   119  
   120  First, update to the [latest cli](https://github.com/cloudfoundry/cli/releases)
   121  and try the command again.
   122  
   123  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.
   124  
   125  ## Plugin Development
   126  
   127  For development guide on writing a cli plugin, see [here](https://github.com/cloudfoundry/cli/tree/master/plugin/plugin_examples).
   128  
   129  ## Contributing & Build Instructions
   130  
   131  Please read the [contributors' guide](.github/CONTRIBUTING.md)
   132  
   133  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.
   134