github.com/mook-as/cf-cli@v7.0.0-beta.28.0.20200120190804-b91c115fae48+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  
    28  Currently, there are two versions of the cf CLI in development: 
    29  - the supported v6 cf CLI. See [here](https://docs.cloudfoundry.org/cf-cli) for more information. 
    30  - v7 beta cf CLI which is currently in development and will be in beta mode until it is completely backed by the [v3 API](http://v3-apidocs.cloudfoundry.org/version/3.75.0/index.html). See [here](https://docs.cloudfoundry.org/cf-cli/v7.html) for more information. 
    31  
    32  
    33  **Important Note**: The v6 CF CLI supports as far back as CF Release v284/CF Deployment v1.7.0 (CAPI Release: 1.46.0 (APIs 2.100.0 and 3.35.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. 
    34  
    35  **Important Note**: The v7 CF CLI beta under rapid development and as such is tested only against CC API v3 Release Candidate.
    36  
    37  If you have any questions, ask away on the #cli channel in [our Slack
    38  community](https://slack.cloudfoundry.org/) and the
    39  [cf-dev](https://lists.cloudfoundry.org/archives/list/cf-dev@lists.cloudfoundry.org/)
    40  mailing list, or [open a GitHub issue](https://github.com/cloudfoundry/cli/issues/new).  You can follow our development progress
    41  on [Core CF CLI Pivotal Tracker](https://www.pivotaltracker.com/n/projects/892938) or [v3/v7 CLI VAT Pivotal Tracker](https://www.pivotaltracker.com/n/projects/2196383).
    42  
    43  ## Getting Started
    44  
    45  Download and install the cf CLI from the [Downloads Section](#downloads) for either the [v6 cf CLI](https://github.com/cloudfoundry/cli/blob/master/README.md#downloading-the-v6-cli) or the [v7 beta cf CLI](https://github.com/cloudfoundry/cli/blob/master/README.md#downloading-the-v7-cli). 
    46  
    47  Once installed, you can log in and push an app.
    48  
    49  ![Example](.github/cf_example.gif)
    50  
    51  Check out our [community contributed CLI plugins](https://plugins.cloudfoundry.org) to further enhance your CLI experience.
    52  
    53  ## Downloads
    54  
    55  ### Downloading the V6 CLI
    56  
    57  It is recommended to download installers from the published URLs or using one of the documented package managers (APT/deb/homebrew repos).  Published URLs may redirect requests to URLs that may change over time, so may installer filenames change over time.
    58  
    59  #### Installing using a package manager
    60  
    61  **Mac OS X** and **Linux** using [Homebrew](https://brew.sh/) via the [cloudfoundry tap](https://github.com/cloudfoundry/homebrew-tap):
    62  
    63  ```sh
    64  brew install cloudfoundry/tap/cf-cli
    65  ```
    66  
    67  **Note:** `cf` tab completion requires `bash-completion` to be installed properly in order to work.
    68  
    69  **Debian** and **Ubuntu** based Linux distributions:
    70  
    71  ```sh
    72  # ...first add the Cloud Foundry Foundation public key and package repository to your system
    73  wget -q -O - https://packages.cloudfoundry.org/debian/cli.cloudfoundry.org.key | sudo apt-key add -
    74  echo "deb https://packages.cloudfoundry.org/debian stable main" | sudo tee /etc/apt/sources.list.d/cloudfoundry-cli.list
    75  # ...then, update your local package index, then finally install the cf CLI
    76  sudo apt-get update
    77  sudo apt-get install cf-cli
    78  ```
    79  
    80  **Enterprise Linux** and **Fedora** systems (RHEL6/CentOS6 and up):
    81  ```sh
    82  # ...first configure the Cloud Foundry Foundation package repository
    83  sudo wget -O /etc/yum.repos.d/cloudfoundry-cli.repo https://packages.cloudfoundry.org/fedora/cloudfoundry-cli.repo
    84  # ...then, install the cf CLI (which will also download and add the public key to your system)
    85  sudo yum install cf-cli
    86  ```
    87  
    88  #### Installers and compressed binaries
    89  
    90  
    91  | | Mac OS X 64 bit | Windows 64 bit | Linux 64 bit |
    92  | :---------------: | :---------------: |:---------------:| :------------:|
    93  | 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) |
    94  | 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) |
    95  
    96  Release notes, and 32 bit releases can be found [here](https://github.com/cloudfoundry/cli/releases).
    97  
    98  **Download examples** with curl for Mac OS X and Linux binaries
    99  ```sh
   100  # ...download & extract Mac OS X binary
   101  curl -L "https://packages.cloudfoundry.org/stable?release=macosx64-binary&source=github" | tar -zx
   102  # ...or Linux 64-bit binary
   103  curl -L "https://packages.cloudfoundry.org/stable?release=linux64-binary&source=github" | tar -zx
   104  # ...move it to /usr/local/bin or a location you know is in your $PATH
   105  mv cf /usr/local/bin
   106  # ...copy tab completion file on Ubuntu (takes affect after re-opening your shell)
   107  sudo curl -o /usr/share/bash-completion/completions/cf https://raw.githubusercontent.com/cloudfoundry/cli/master/ci/installers/completion/cf
   108  # ...and to confirm your cf CLI version
   109  cf --version
   110  ```
   111  
   112  ##### Edge binaries
   113  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.
   114  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).
   115  
   116  ---------------------------------------
   117  
   118  
   119  ### Downloading the V7 beta CLI
   120  
   121  **Important Note**: The v7 CF CLI beta under rapid development and as such is tested only against CC API v3 Release Candidate. Use at your own risk. See [releases](https://github.com/cloudfoundry/cli/releases) for more information. 
   122  
   123  #### Compatibility
   124  The V7 CLI is developed and tested against CAPI release candidates. See the [releases](https://github.com/cloudfoundry/cli/releases) page for the minimum CAPI RC version required for each V7 beta version.
   125  
   126  #### Installing using a package manager
   127  
   128  **Mac OS X** and **Linux** using [Homebrew](https://brew.sh/) via the [cloudfoundry tap](https://github.com/cloudfoundry/homebrew-tap):
   129  
   130  ```sh
   131  brew install cloudfoundry/tap/cf7-cli
   132  ```
   133  
   134  **Note:** `cf7` tab completion requires `bash-completion` to be installed properly in order to work.
   135  
   136  **Debian** and **Ubuntu** based Linux distributions:
   137  
   138  ```sh
   139  # ...first add the Cloud Foundry Foundation public key and package repository to your system
   140  wget -q -O - https://packages.cloudfoundry.org/debian/cli.cloudfoundry.org.key | sudo apt-key add -
   141  echo "deb https://packages.cloudfoundry.org/debian stable main" | sudo tee /etc/apt/sources.list.d/cloudfoundry-cli.list
   142  # ...then, update your local package index, then finally install the cf CLI
   143  sudo apt-get update
   144  sudo apt-get install cf7-cli
   145  ```
   146  
   147  **Enterprise Linux** and **Fedora** systems (RHEL6/CentOS6 and up):
   148  ```sh
   149  # ...first configure the Cloud Foundry Foundation package repository
   150  sudo wget -O /etc/yum.repos.d/cloudfoundry-cli.repo https://packages.cloudfoundry.org/fedora/cloudfoundry-cli.repo
   151  # ...then, install the cf CLI (which will also download and add the public key to your system)
   152  sudo yum install cf7-cli
   153  ```
   154  
   155  
   156  #### Installers and compressed binaries
   157  
   158  
   159  
   160  
   161  | | Mac OS X 64 bit | Windows 64 bit | Linux 64 bit |
   162  | :---------------: | :---------------: |:---------------:| :------------:|
   163  | Installers |[pkg](https://packages.cloudfoundry.org/stable?release=macosx64&version=v7&source=github) | [zip](https://packages.cloudfoundry.org/stable?release=windows64&version=v7&source=github) | [rpm](https://packages.cloudfoundry.org/stable?release=redhat64&version=v7&source=github) / [deb](https://packages.cloudfoundry.org/stable?release=debian64&version=v7&source=github) |
   164  | Binaries | [tgz](https://packages.cloudfoundry.org/stable?release=macosx64-binary&version=v7&source=github) |[zip](https://packages.cloudfoundry.org/stable?release=windows64-exe&version=v7&source=github)  | [tgz](https://packages.cloudfoundry.org/stable?release=linux64-binary&version=v7&source=github) |
   165  
   166  Release notes, and 32 bit releases can be found [here](https://github.com/cloudfoundry/cli/releases).
   167  
   168  **Download examples** with curl for Mac OS X and Linux binaries
   169  ```sh
   170  # ...download & extract Mac OS X binary
   171  curl -L "https://packages.cloudfoundry.org/stable?release=macosx64-binary&version=v7&source=github" | tar -zx
   172  # ...or Linux 64-bit binary
   173  curl -L "https://packages.cloudfoundry.org/stable?release=linux64-binary&version=v7&source=github" | tar -zx
   174  # ...move it to /usr/local/bin or a location you know is in your $PATH
   175  mv cf7 /usr/local/bin
   176  # ...copy tab completion file on Ubuntu (takes affect after re-opening your shell)
   177  sudo curl -o /usr/share/bash-completion/completions/cf7 https://raw.githubusercontent.com/cloudfoundry/cli/master/ci/installers/completion/cf7
   178  # ...and to confirm your cf CLI version
   179  cf7 --version
   180  ```
   181  
   182  ##### Edge binaries
   183  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.
   184  Follow these download links for [Mac OS X 64 bit](https://packages.cloudfoundry.org/edge?arch=macosx64&version=v7&source=github), [Windows 64 bit](https://packages.cloudfoundry.org/edge?arch=windows64&version=v7&source=github) and [Linux 64 bit](https://packages.cloudfoundry.org/edge?arch=linux64&version=v7&source=github).
   185  
   186  
   187  
   188  ## Known Issues
   189  
   190  * On Windows in Cygwin and Git Bash, interactive password prompts (in `cf login`) do not hide the password properly from stdout ([issue #1835](https://github.com/cloudfoundry/cli/issues/1835)). Please use an alternative command (non-interactive authentication `cf auth` instead of `cf login`) to work around this. Or, use the Windows `cmd` command line.
   191  * 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.
   192  * On Windows, `cf ssh` will hang when run from the MINGW32 or MINGW64 shell. A workaround is to use PowerShell instead.
   193  * 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`.
   194  * 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.
   195  * .cfignore used in `cf push` must be in UTF-8 encoding for CLI to interpret correctly. ([issue #281](https://github.com/cloudfoundry/cli/issues/281#issuecomment-65315518))
   196  * 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).
   197  
   198  ## Filing Issues & Feature Requests
   199  
   200  First, update to the [latest cli](https://github.com/cloudfoundry/cli/releases)
   201  and try the command again.
   202  
   203  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.
   204  
   205  ## Plugin Development
   206  
   207  The CF CLI supports external code execution via the plugins API. For more
   208  information follow:
   209  
   210  * [The CF CLI plugin development guide](https://github.com/cloudfoundry/cli/tree/master/plugin/plugin_examples)
   211  * [The official plugins repository](https://plugins.cloudfoundry.org/)
   212  
   213  When importing the plugin code use `import "code.cloudfoundry.org/cli/plugin"`.
   214  Older plugins that import `github.com/cloudfoundry/cli/plugin` will still work
   215  as long they vendor the plugins directory.
   216  
   217  ## Contributing & Build Instructions
   218  
   219  Please read the [contributors' guide](.github/CONTRIBUTING.md)
   220  
   221  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.
   222  
   223