github.com/nimakaviani/cli@v6.37.1-0.20180619223813-e734901a73fa+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 17 # Cloud Foundry CLI 18 19 [![GitHub version](https://badge.fury.io/gh/cloudfoundry%2Fcli.svg)](https://github.com/cloudfoundry/cli/releases/latest) 20 [![Documentation](https://img.shields.io/badge/docs-online-ff69b4.svg)](https://docs.cloudfoundry.org/cf-cli) 21 [![Command help pages](https://img.shields.io/badge/command-help-lightgrey.svg)](https://cli.cloudfoundry.org) 22 [![Slack](https://slack.cloudfoundry.org/badge.svg)](https://slack.cloudfoundry.org) 23 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/cloudfoundry/cli/blob/master/LICENSE) 24 25 ***Cloud Foundry CLI*** is the official command line client for [Cloud Foundry](https://cloudfoundry.org). 26 Latest help of each command is [here](https://cli.cloudfoundry.org) (or run `cf help`); 27 Further documentation is at the [docs page for the 28 CLI](https://docs.cloudfoundry.org/cf-cli). 29 30 **Note**: CF CLI supports as far back as CF Release v251 (CAPI Release: 1.15.0 (APIs 2.69.0 and 3.4.0). See our [wiki](https://github.com/cloudfoundry/cli/wiki/Versioning-Policy#cf-cli-minimum-supported-version) for more information. If you are on an older version of CF Release, we recommend you upgrade to a supported version. 31 32 If you have any questions, ask away on the #cli channel in [our Slack 33 community](https://slack.cloudfoundry.org/) and the 34 [cf-dev](https://lists.cloudfoundry.org/archives/list/cf-dev@lists.cloudfoundry.org/) 35 mailing list, or [open a GitHub issue](https://github.com/cloudfoundry/cli/issues/new). You can follow our development progress 36 on [Pivotal Tracker](https://www.pivotaltracker.com/n/projects/892938). 37 38 ## Getting Started 39 40 Download and install the cf CLI from the [Downloads Section](#downloads). 41 42 Once installed, you can log in and push an app. 43 44 ![Example](.github/cf_example.gif) 45 46 Check out our [community contributed CLI plugins](https://plugins.cloudfoundry.org) to further enhance your CLI experience. 47 48 ## Downloads 49 50 ### Installing using a package manager 51 52 **Mac OS X** and **Linux** using [Homebrew](https://brew.sh/) via the [cloudfoundry tap](https://github.com/cloudfoundry/homebrew-tap): 53 54 ```sh 55 brew install cloudfoundry/tap/cf-cli 56 ``` 57 58 **Debian** and **Ubuntu** based Linux distributions: 59 60 ```sh 61 # ...first add the Cloud Foundry Foundation public key and package repository to your system 62 wget -q -O - https://packages.cloudfoundry.org/debian/cli.cloudfoundry.org.key | sudo apt-key add - 63 echo "deb https://packages.cloudfoundry.org/debian stable main" | sudo tee /etc/apt/sources.list.d/cloudfoundry-cli.list 64 # ...then, update your local package index, then finally install the cf CLI 65 sudo apt-get update 66 sudo apt-get install cf-cli 67 ``` 68 69 **Enterprise Linux** and **Fedora** systems (RHEL6/CentOS6 and up): 70 ```sh 71 # ...first configure the Cloud Foundry Foundation package repository 72 sudo wget -O /etc/yum.repos.d/cloudfoundry-cli.repo https://packages.cloudfoundry.org/fedora/cloudfoundry-cli.repo 73 # ...then, install the cf CLI (which will also download and add the public key to your system) 74 sudo yum install cf-cli 75 ``` 76 77 ### Installers and compressed binaries 78 79 | | Mac OS X 64 bit | Windows 64 bit | Linux 64 bit | 80 | :---------------: | :---------------: |:---------------:| :------------:| 81 | Installers | [pkg](https://packages.cloudfoundry.org/stable?release=macosx64&source=github) | [zip](https://packages.cloudfoundry.org/stable?release=windows64&source=github) | [rpm](https://packages.cloudfoundry.org/stable?release=redhat64&source=github) / [deb](https://packages.cloudfoundry.org/stable?release=debian64&source=github) | 82 | Binaries | [tgz](https://packages.cloudfoundry.org/stable?release=macosx64-binary&source=github) | [zip](https://packages.cloudfoundry.org/stable?release=windows64-exe&source=github) | [tgz](https://packages.cloudfoundry.org/stable?release=linux64-binary&source=github) | 83 84 Release notes, and 32 bit releases can be found [here](https://github.com/cloudfoundry/cli/releases). 85 86 **Download examples** with curl for Mac OS X and Linux binaries 87 ```sh 88 # ...download & extract Mac OS X binary 89 curl -L "https://packages.cloudfoundry.org/stable?release=macosx64-binary&source=github" | tar -zx 90 # ...or Linux 64-bit binary 91 curl -L "https://packages.cloudfoundry.org/stable?release=linux64-binary&source=github" | tar -zx 92 # ...move it to /usr/local/bin or a location you know is in your $PATH 93 mv cf /usr/local/bin 94 # ...copy tab completion file on Ubuntu (takes affect after re-opening your shell) 95 sudo curl -o /usr/share/bash-completion/completions/cf https://raw.githubusercontent.com/cloudfoundry/cli/master/ci/installers/completion/cf 96 # ...and to confirm your cf CLI version 97 cf --version 98 ``` 99 100 #### Edge binaries 101 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. 102 Follow these download links for [Mac OS X 64 bit](https://packages.cloudfoundry.org/edge?arch=macosx64&source=github), [Windows 64 bit](https://packages.cloudfoundry.org/edge?arch=windows64&source=github) and [Linux 64 bit](https://packages.cloudfoundry.org/edge?arch=linux64&source=github). 103 104 ## Known Issues 105 106 * In Cygwin and Git Bash on Windows, interactive password prompts (in `cf login`) do not work ([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. 107 * On Windows, `cf ssh` may not display correctly if the `TERM` is not set. We've found that setting `TERM` to `msys` fixes some of these issues. 108 * CF CLI/GoLang do not use OpenSSL. Custom/Self Signed Certificates need to be [installed in specific locations](https://docs.cloudfoundry.org/cf-cli/self-signed.html) in order to `login`/`auth` without `--skip-ssl-validation`. 109 * 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 [this Diego-Enabler plugin issue](https://github.com/cloudfoundry-attic/Diego-Enabler/issues/6) for more information. 110 * .cfignore used in `cf push` must be in UTF-8 encoding for CLI to interpret correctly. 111 * 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](https://askubuntu.com/questions/133389/no-such-file-or-directory-but-the-file-exists). 112 * Using non-refactored commands with verbose mode turned on will display the refresh token in the terminal. 113 114 ## Filing Issues & Feature Requests 115 116 First, update to the [latest cli](https://github.com/cloudfoundry/cli/releases) 117 and try the command again. 118 119 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. 120 121 ## Plugin Development 122 123 For development guide on writing a cli plugin, see [here](https://github.com/cloudfoundry/cli/tree/master/plugin/plugin_examples). 124 125 ## Contributing & Build Instructions 126 127 Please read the [contributors' guide](.github/CONTRIBUTING.md) 128 129 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. 130