github.com/jasonkeene/cli@v6.14.1-0.20160816203908-ca5715166dfb+incompatible/README.md (about)

     1  # Cloud Foundry CLI [![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](cloudfoundry.org).
     4  Latest help of each command is [here](cli.cloudfoundry.org) (or run `cf help`);
     5  Further documentation is at the [docs page for the
     6  CLI](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  ## Downloads
    34  
    35  **Latest stable:** Download the installer or compressed binary for your platform:
    36  
    37  | | Mac OS X 64 bit | Windows 64 bit | Linux 64 bit |
    38  | :---------------: | :---------------: |:---------------:| :------------:|
    39  | 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) |
    40  | 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) |
    41  
    42  **From the command line:** Download examples with curl for Mac OS X and Linux
    43  ```
    44  # ...download & extract Mac OS X binary
    45  $ curl -L "https://cli.run.pivotal.io/stable?release=macosx64-binary&source=github" | tar -zx
    46  # ...or Linux binary
    47  $ curl -L "https://cli.run.pivotal.io/stable?release=linux64-binary&source=github" | tar -zx
    48  # ...and confirm you got the version you expected
    49  $ ./cf --version
    50  cf version x.y.z-...
    51  ```
    52  
    53  **Via Homebrew:** Install CF for OSX through [Homebrew](http://brew.sh/) via the [cloudfoundry tap](https://github.com/cloudfoundry/homebrew-tap):
    54  
    55  ```
    56  $ brew tap cloudfoundry/tap
    57  $ brew install cf-cli
    58  ```
    59  
    60  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.
    61  These binaries are *not intended for wider use*; they're for developers to test new features and fixes as they are completed.
    62  
    63  **Releases:** 32 bit releases and information about all our releases can be found [here](https://github.com/cloudfoundry/cli/releases)
    64  
    65  ## Known Issues
    66  
    67  * 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.
    68  * .cfignore used in `cf push` must be in UTF8 encoding for CLI to interpret correctly.
    69  * 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
    70  
    71  ## Filing Issues
    72  
    73  First, update to the [latest cli](https://github.com/cloudfoundry/cli/releases)
    74  and try the command again.
    75  
    76  If the error remains, run the command that exposes the bug with the environment
    77  variable CF_TRACE set to true and [create an
    78  issue](https://github.com/cloudfoundry/cli/issues).
    79  
    80  Include the below information when creating the issue:
    81  
    82  * The error that occurred
    83  * The stack trace (if applicable)
    84  * The command you ran (e.g. `cf org-users`)
    85  * The CLI Version (e.g. 6.13.0-dfba612)
    86  * Your platform details (e.g. Mac OS X 10.11, Windows 8.1 64-bit, Ubuntu 14.04.3 64-bit)
    87  * The shell you used (e.g. Terminal, iTerm, Powershell, Cygwin, gnome-terminal, terminator)
    88  
    89  ##### For simple issues (eg: text formatting, help messages, etc), please provide
    90  
    91  - the command you ran
    92  - what occurred
    93  - what you expected to occur
    94  
    95  ##### For issues related to HTTP requests or strange behavior, please run the command with env var `CF_TRACE=true` and provide
    96  
    97  - the command you ran
    98  - the trace output
    99  - a high-level description of the bug
   100  
   101  ##### For panics and other crashes, please provide
   102  
   103  - the command you ran
   104  - the stack trace generated (if any)
   105  - any other relevant information
   106  
   107  ## Plugins
   108  
   109  For development guide on writing a cli plugin, see [here](https://github.com/cloudfoundry/cli/tree/master/plugin_examples).
   110  
   111  ## Contributing
   112  
   113  Please read the [contributors' guide](CONTRIBUTING.md)
   114  
   115  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.
   116