cf-cli

command module
v0.0.0-...-1fe19bb Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 28, 2023 License: Apache-2.0 Imports: 9 Imported by: 0

README

CF logo

Cloud Foundry CLI

The official command line client for Cloud Foundry.

View the latest help for The v8 CLI -OR- The v7 CLI -OR- The v6 CLI, or run cf help -a to view the help for all commands available in your currently installed version.

GitHub version Documentation Command help pages Slack License

CF CLI Binary Download Server's uptime:

Downloads Uptime


Sections: Getting Started | Download | Known Issues | Bugs/Feature Requests | Plugin Development | Contributing


Getting Started

Download and install the cf CLI from the Downloads Section for either the v8 cf CLI or the v7 cf CLI or the v6 cf CLI.

Once installed, you can log in and push an app. There are now three supported versions of the cf CLI:

  1. The v8 cf CLI is backed by the v3 CC API (with the exception of plugins). See our v8 documentation for more information.
  2. The v7 cf CLI is backed by the v3 CC API (with the exception of plugins). See our v7 documentation for more information.
  3. The v6 cf CLI is backed by the v2 CC API See our v6 documentation for more information.

View our CLI v6 & v7 & v8 Versioning and Support Policy documentation.

If you have any questions, ask away on the #cli channel in our Slack community and the cf-dev mailing list, or open a GitHub issue.
You can follow our development progress on Core CF CLI Pivotal Tracker.

Contributing & Build Instructions

Please read the contributors' guide

If you'd like to submit updated translations, please see the i18n README for instructions on how to submit an update.

Example

Check out our community contributed CLI plugins to further enhance your CLI experience.

Downloads

Installation instructions

Known Issues

Note: For most up-to-date information in issues and workarounds please review the open and closed github issues

  • On Windows in Cygwin and Git Bash, interactive password prompts (in cf login) do not hide the password properly from stdout (issue #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.
  • 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.
  • On Windows, cf ssh will hang when run from the MINGW32 or MINGW64 shell. A workaround is to use PowerShell instead.
  • CF CLI/GoLang do not use OpenSSL. Custom/Self Signed Certificates need to be installed in specific locations in order to login/auth without --skip-ssl-validation.
  • 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 for more information.
  • .cfignore used in cf push must be in UTF-8 encoding for CLI to interpret correctly. (issue #281)
  • 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.
  • 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
  • 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.

Filing Issues & Feature Requests

First, update to the latest cli and try the command again.

If the error remains or feature still missing, check the open issues and if not already raised please file a new issue with the requested details.

Plugin Development

The CF CLI supports external code execution via the plugins API. For more information follow:

When importing the plugin code use import "code.cloudfoundry.org/cli/plugin". Older plugins that import github.com/cloudfoundry/cli/plugin will still work as long they vendor the plugins directory.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
actor
cfnetworkingaction
Package cfnetworkingaction contains the business logic for the cf networking commands.
Package cfnetworkingaction contains the business logic for the cf networking commands.
cfnetworkingaction/cfnetworkingactionfakes
Code generated by counterfeiter.
Code generated by counterfeiter.
pluginaction
Package pluginaction handles all operations related to plugin commands
Package pluginaction handles all operations related to plugin commands
pluginaction/pluginactionfakes
Code generated by counterfeiter.
Code generated by counterfeiter.
sharedaction
Package sharedaction handles all operations that do not require a cloud controller
Package sharedaction handles all operations that do not require a cloud controller
sharedaction/sharedactionfakes
Code generated by counterfeiter.
Code generated by counterfeiter.
v7action
Package v7action contains the business logic for the commands/v7 package
Package v7action contains the business logic for the commands/v7 package
v7action/v7actionfakes
Code generated by counterfeiter.
Code generated by counterfeiter.
v7pushaction
Package v7pushaction contains the business logic for orchestrating a V2 app push.
Package v7pushaction contains the business logic for orchestrating a V2 app push.
v7pushaction/v7pushactionfakes
Code generated by counterfeiter.
Code generated by counterfeiter.
api
cloudcontroller
Package cloudcontroller contains shared utilities between the V2 and V3 clients.
Package cloudcontroller contains shared utilities between the V2 and V3 clients.
cloudcontroller/ccv3
Package ccv3 represents a Cloud Controller V3 client.
Package ccv3 represents a Cloud Controller V3 client.
cloudcontroller/ccv3/ccv3fakes
Code generated by counterfeiter.
Code generated by counterfeiter.
cloudcontroller/ccv3/constant
Package constant contains types and constants used by the ccv3 package.
Package constant contains types and constants used by the ccv3 package.
cloudcontroller/cloudcontrollerfakes
Code generated by counterfeiter.
Code generated by counterfeiter.
cloudcontroller/wrapper/wrapperfakes
Code generated by counterfeiter.
Code generated by counterfeiter.
plugin/pluginfakes
Code generated by counterfeiter.
Code generated by counterfeiter.
plugin/wrapper/wrapperfakes
Code generated by counterfeiter.
Code generated by counterfeiter.
router
Package router is a GoLang library that interacts with CloudFoundry Go Router
Package router is a GoLang library that interacts with CloudFoundry Go Router
router/routerfakes
Code generated by counterfeiter.
Code generated by counterfeiter.
router/wrapper/wrapperfakes
Code generated by counterfeiter.
Code generated by counterfeiter.
shared/sharedfakes
Code generated by counterfeiter.
Code generated by counterfeiter.
uaa
Package uaa is a GoLang library that interacts with CloudFoundry User Account and Authentication (UAA) Server.
Package uaa is a GoLang library that interacts with CloudFoundry User Account and Authentication (UAA) Server.
uaa/constant
Package constant contains types and constants used by the uaa package.
Package constant contains types and constants used by the uaa package.
uaa/noaabridge
Package noaabridge wraps a UAA client and a tokenCache to support the TokenRefresher interface for noaa/consumer.
Package noaabridge wraps a UAA client and a tokenCache to support the TokenRefresher interface for noaa/consumer.
uaa/noaabridge/noaabridgefakes
Code generated by counterfeiter.
Code generated by counterfeiter.
uaa/uaafakes
Code generated by counterfeiter.
Code generated by counterfeiter.
uaa/wrapper/wrapperfakes
Code generated by counterfeiter.
Code generated by counterfeiter.
bin
cf
actors/actorsfakes
Code generated by counterfeiter.
Code generated by counterfeiter.
actors/brokerbuilder/brokerbuilderfakes
Code generated by counterfeiter.
Code generated by counterfeiter.
actors/planbuilder/planbuilderfakes
Code generated by counterfeiter.
Code generated by counterfeiter.
actors/plugininstaller/plugininstallerfakes
Code generated by counterfeiter.
Code generated by counterfeiter.
actors/pluginrepo/pluginrepofakes
Code generated by counterfeiter.
Code generated by counterfeiter.
actors/servicebuilder/servicebuilderfakes
Code generated by counterfeiter.
Code generated by counterfeiter.
actors/userprint/userprintfakes
Code generated by counterfeiter.
Code generated by counterfeiter.
api
api/apifakes
Code generated by counterfeiter.
Code generated by counterfeiter.
api/appevents/appeventsfakes
This file was generated by counterfeiter
This file was generated by counterfeiter
api/appfiles/appfilesfakes
This file was generated by counterfeiter
This file was generated by counterfeiter
api/appinstances/appinstancesfakes
This file was generated by counterfeiter
This file was generated by counterfeiter
api/applicationbits/applicationbitsfakes
This file was generated by counterfeiter
This file was generated by counterfeiter
api/applications/applicationsfakes
Code generated by counterfeiter.
Code generated by counterfeiter.
api/authentication/authenticationfakes
Code generated by counterfeiter.
Code generated by counterfeiter.
api/copyapplicationsource/copyapplicationsourcefakes
Code generated by counterfeiter.
Code generated by counterfeiter.
Code generated by counterfeiter.
api/featureflags/featureflagsfakes
Code generated by counterfeiter.
Code generated by counterfeiter.
api/logs/logsfakes
Code generated by counterfeiter.
Code generated by counterfeiter.
api/organizations/organizationsfakes
Code generated by counterfeiter.
Code generated by counterfeiter.
api/password/passwordfakes
Code generated by counterfeiter.
Code generated by counterfeiter.
api/quotas/quotasfakes
Code generated by counterfeiter.
Code generated by counterfeiter.
api/securitygroups/defaults/running/runningfakes
Code generated by counterfeiter.
Code generated by counterfeiter.
api/securitygroups/defaults/staging/stagingfakes
Code generated by counterfeiter.
Code generated by counterfeiter.
api/securitygroups/securitygroupsfakes
Code generated by counterfeiter.
Code generated by counterfeiter.
api/securitygroups/spaces/spacesfakes
Code generated by counterfeiter.
Code generated by counterfeiter.
api/spacequotas/spacequotasfakes
Code generated by counterfeiter.
Code generated by counterfeiter.
api/spaces/spacesfakes
Code generated by counterfeiter.
Code generated by counterfeiter.
api/stacks/stacksfakes
Code generated by counterfeiter.
Code generated by counterfeiter.
appfiles/appfilesfakes
Code generated by counterfeiter.
Code generated by counterfeiter.
cmd
commandregistry/commandregistryfakes
Code generated by counterfeiter.
Code generated by counterfeiter.
commands/application/applicationfakes
Code generated by counterfeiter.
Code generated by counterfeiter.
commands/commandsfakes
Code generated by counterfeiter.
Code generated by counterfeiter.
commands/route/routefakes
Code generated by counterfeiter.
Code generated by counterfeiter.
commands/service/servicefakes
Code generated by counterfeiter.
Code generated by counterfeiter.
commands/user/userfakes
Code generated by counterfeiter.
Code generated by counterfeiter.
configuration/configurationfakes
Code generated by counterfeiter.
Code generated by counterfeiter.
configuration/coreconfig/coreconfigfakes
Code generated by counterfeiter.
Code generated by counterfeiter.
configuration/pluginconfig/pluginconfigfakes
Code generated by counterfeiter.
Code generated by counterfeiter.
errors/errorsfakes
Code generated by counterfeiter.
Code generated by counterfeiter.
manifest/manifestfakes
Code generated by counterfeiter.
Code generated by counterfeiter.
net
net/netfakes
Code generated by counterfeiter.
Code generated by counterfeiter.
requirements/requirementsfakes
Code generated by counterfeiter.
Code generated by counterfeiter.
ssh
ssh/sshfakes
Code generated by counterfeiter.
Code generated by counterfeiter.
ssh/terminal/terminalfakes
Code generated by counterfeiter.
Code generated by counterfeiter.
terminal/terminalfakes
Code generated by counterfeiter.
Code generated by counterfeiter.
trace/tracefakes
Code generated by counterfeiter.
Code generated by counterfeiter.
util/testhelpers/rpcserver/rpcserverfakes
Code generated by counterfeiter.
Code generated by counterfeiter.
util/utilfakes
Code generated by counterfeiter.
Code generated by counterfeiter.
Package command should not be imported by external consumers.
Package command should not be imported by external consumers.
commandfakes
Code generated by counterfeiter.
Code generated by counterfeiter.
common
Package common should not be imported by external consumers.
Package common should not be imported by external consumers.
common/commonfakes
Code generated by counterfeiter.
Code generated by counterfeiter.
flag
Package flag should not be imported by external consumers.
Package flag should not be imported by external consumers.
plugin
Package plugin should not be imported by external consumers.
Package plugin should not be imported by external consumers.
plugin/pluginfakes
Code generated by counterfeiter.
Code generated by counterfeiter.
plugin/shared
Package shared should not be imported by external consumers.
Package shared should not be imported by external consumers.
translatableerror
Package translatableerror contains all the command layer translatable errors.
Package translatableerror contains all the command layer translatable errors.
translatableerror/translatableerrorfakes
Code generated by counterfeiter.
Code generated by counterfeiter.
v7
Package v7 should not be imported by external consumers.
Package v7 should not be imported by external consumers.
v7/shared
Package shared should not be imported by external consumers.
Package shared should not be imported by external consumers.
v7/shared/sharedfakes
Code generated by counterfeiter.
Code generated by counterfeiter.
v7/v7fakes
Code generated by counterfeiter.
Code generated by counterfeiter.
fixtures
i18n
integration
plugin_examples
* * This is an example plugin where we use both arguments and flags.
* * This is an example plugin where we use both arguments and flags.
plugin_examples/test_rpc_server_example
* * This plugin demonstrate the use of Test driven development using the test rpc server * This allows the plugin to be tested independently without relying on CF CLI
* * This plugin demonstrate the use of Test driven development using the test rpc server * This allows the plugin to be tested independently without relying on CF CLI
pluginfakes
Code generated by counterfeiter.
Code generated by counterfeiter.
rpc
rpc/rpcfakes
Code generated by counterfeiter.
Code generated by counterfeiter.
clissh/clisshfakes
Code generated by counterfeiter.
Code generated by counterfeiter.
configv3
Package configv3 package contains everything related to the CF CLI Configuration.
Package configv3 package contains everything related to the CF CLI Configuration.
configv3/configv3fakes
Code generated by counterfeiter.
Code generated by counterfeiter.
download/downloadfakes
Code generated by counterfeiter.
Code generated by counterfeiter.
ui
Package ui will provide hooks into STDOUT, STDERR and STDIN.
Package ui will provide hooks into STDOUT, STDERR and STDIN.
ui/uifakes
Code generated by counterfeiter.
Code generated by counterfeiter.
utilfakes
Code generated by counterfeiter.
Code generated by counterfeiter.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL