github.com/wanddynosios/cli/v8@v8.7.9-0.20240221182337-1a92e3a7017f/README.md (about) 1 2 3 <img src="https://raw.githubusercontent.com/cloudfoundry/logos/master/CF_Icon_4-colour.png" alt="CF logo" height="100" align="left"/> 4 5 # Cloud Foundry CLI 6 The official command line client for [Cloud Foundry](https://cloudfoundry.org). 7 8 View the latest help for [**The v8 CLI**](https://cli.cloudfoundry.org/en-US/v8) -OR- [**The v7 CLI**](https://cli.cloudfoundry.org/en-US/v7) -OR- [**The v6 CLI**](https://cli.cloudfoundry.org/en-US/v6), or run `cf help -a` to view the help for all commands available in your currently installed version. 9 10 [![GitHub version](https://badge.fury.io/gh/cloudfoundry%2Fcli.svg)](https://github.com/cloudfoundry/cli/releases/latest) 11 [![Documentation](https://img.shields.io/badge/docs-online-ff69b4.svg)](https://docs.cloudfoundry.org/cf-cli) 12 [![Command help pages](https://img.shields.io/badge/command-help-lightgrey.svg)](https://cli.cloudfoundry.org) 13 [![Slack](https://slack.cloudfoundry.org/badge.svg)](https://slack.cloudfoundry.org) 14 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/cloudfoundry/cli/blob/master/LICENSE) 15 16 CF CLI Binary Download Server's uptime: 17 18 [![Downloads Uptime](https://uptime.com/devices/services/widget/689896/c6d4bb7ddd16186d/service?light)](https://uptime.com/devices/services/689896/01026e1a663caab4) 19 20 *** 21 <p align="left"> 22 <b>Sections: </b> 23 <b><a href="#getting-started">Getting Started</a></b> 24 | 25 <b><a href="#downloads">Download</a></b> 26 | 27 <b><a href="#known-issues">Known Issues</a></b> 28 | 29 <b><a href="#filing-issues--feature-requests">Bugs/Feature Requests</a></b> 30 | 31 <b><a href="#plugin-development">Plugin Development</a></b> 32 | 33 <b><a href="#contributing--build-instructions">Contributing</a></b> 34 </p> 35 36 *** 37 ## Getting Started 38 Download and install the cf CLI from the [Downloads Section](#downloads) for either the [v8 cf CLI](https://github.com/cloudfoundry/cli/wiki/V8-CLI-Installation-Guide) or the [v7 cf CLI](https://github.com/cloudfoundry/cli/wiki/V7-CLI-Installation-Guide) or the [v6 cf CLI](https://github.com/cloudfoundry/cli/wiki/V6-CLI-Installation-Guide). 39 40 Once installed, you can log in and push an app. 41 There are now three supported versions of the cf CLI: 42 1. The v8 cf CLI is backed by the [v3 CC API](http://v3-apidocs.cloudfoundry.org/version/3.85.0/) (with the exception of plugins). See [our v8 documentation](https://docs.cloudfoundry.org/cf-cli/v8.html) for more information. 43 1. The v7 cf CLI is backed by the [v3 CC API](http://v3-apidocs.cloudfoundry.org/version/3.85.0/) (with the exception of plugins). See [our v7 documentation](https://docs.cloudfoundry.org/cf-cli/v7.html) for more information. 44 1. The v6 cf CLI is backed by the [v2 CC API](https://apidocs.cloudfoundry.org/13.5.0/) See [our v6 documentation](https://docs.cloudfoundry.org/cf-cli) for more information. 45 46 View our [CLI v6 & v7 & v8 Versioning and Support Policy](https://github.com/cloudfoundry/cli/wiki/Versioning-and-Support-Policy) documentation. 47 48 If you have any questions, ask away on the #cli channel in [our Slack 49 community](https://slack.cloudfoundry.org/) and the 50 [cf-dev](https://lists.cloudfoundry.org/archives/list/cf-dev@lists.cloudfoundry.org/) 51 mailing list, or [open a GitHub issue](https://github.com/cloudfoundry/cli/issues/new). 52 You can follow our development progress 53 on [Core CF CLI Pivotal Tracker](https://www.pivotaltracker.com/n/projects/892938). 54 55 ## Contributing & Build Instructions 56 Please read the [contributors' guide](.github/CONTRIBUTING.md) 57 58 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. 59 60 ![Example](.github/cf_example.gif) 61 62 Check out our [community contributed CLI plugins](https://plugins.cloudfoundry.org) to further enhance your CLI experience. 63 64 ## Downloads 65 66 ### Installation instructions 67 - [Install V6](https://github.com/cloudfoundry/cli/wiki/V6-CLI-Installation-Guide) 68 - [Install V7](https://github.com/cloudfoundry/cli/wiki/V7-CLI-Installation-Guide) 69 - [Install V8](https://github.com/cloudfoundry/cli/wiki/V8-CLI-Installation-Guide) 70 - [Switching Between Multiple Versions](https://github.com/cloudfoundry/cli/wiki/Version-Switching-Guide) 71 72 ## Known Issues 73 **Note:** For most up-to-date information in issues and workarounds please review [the open and closed github issues](https://github.com/cloudfoundry/cli/issues) 74 75 * 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. 76 * 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. 77 * On Windows, `cf ssh` will hang when run from the MINGW32 or MINGW64 shell. A workaround is to use PowerShell instead. 78 * 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`. 79 * 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. 80 * .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)) 81 * 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). 82 * X-Cf-Warnings are printed through the `stdout`, if that's an inconvenience you could set `CF_RAISE_ERROR_ON_WARNINGS` and in that case warnings will be printed through the `stderr`. See [X-Cf-Warnings printed through stdout issue](https://github.com/cloudfoundry/cli/issues/2164) 83 * False negative message for user org creation. CLI v7.0 and CLI v7.1 non-admin users with the user-org-creation feature flag enabled will experience a failure when running cf create-org. The command will explicitly fail attempting to grant the user an org-manager role. However, it actually succeeds because the user would have an org-manager role granted to them via CAPI and therefore be able to access their org. This issue is resolved as of CLI v7.2. See [Inconsistent v2/v3 behavior around creating new orgs + assigning roles](https://github.com/cloudfoundry/cloud_controller_ng/issues/1879). 84 85 ## Filing Issues & Feature Requests 86 87 First, update to the [latest cli](https://github.com/cloudfoundry/cli/releases) 88 and try the command again. 89 90 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. 91 92 ## Plugin Development 93 94 The CF CLI supports external code execution via the plugins API. For more 95 information follow: 96 97 * [The CF CLI plugin development guide](https://github.com/cloudfoundry/cli/tree/master/plugin/plugin_examples) 98 * [The official plugins repository](https://plugins.cloudfoundry.org/) 99 100 When importing the plugin code use `import "code.cloudfoundry.org/cli/plugin"`. 101 Older plugins that import `github.com/cloudfoundry/cli/plugin` will still work 102 as long they vendor the plugins directory.