cli

command module
v6.24.0+incompatible Latest Latest
Warning

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

Go to latest
Published: Feb 10, 2017 License: Apache-2.0 Imports: 13 Imported by: 1

README

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

CF logo # Cloud Foundry CLI [![GitHub version](https://badge.fury.io/gh/cloudfoundry%2Fcli.svg)](https://github.com/cloudfoundry/cli/releases/latest) [![Documentation](https://img.shields.io/badge/docs-online-ff69b4.svg)](https://docs.cloudfoundry.org/cf-cli) [![Command help pages](https://img.shields.io/badge/command-help-lightgrey.svg)](https://cli.cloudfoundry.org) [![Slack](https://slack.cloudfoundry.org/badge.svg)](https://slack.cloudfoundry.org) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/cloudfoundry/cli/blob/master/LICENSE) [![Code Climate](https://codeclimate.com/github/cloudfoundry/cli/badges/gpa.svg)](https://codeclimate.com/github/cloudfoundry/cli)

This is the official command line client for Cloud Foundry. Latest help of each command is here (or run cf help); Further documentation is at the docs page for the CLI.

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 Pivotal Tracker.

Getting Started

Download and install the cf CLI from the Downloads Section.

Once installed, you can log in and push an app.

$ cf login -a api.[my-cloudfoundry].com
API endpoint: https://api.[my-cloudfoundry].com

Email> [my-email]

Password> [my-password]
Authenticating...
OK

$ cd [my-app-directory]
$ cf push

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

Downloads

Installing using a package manager

Mac OS X (using Homebrew via the cloudfoundry tap):

$ brew tap cloudfoundry/tap
$ brew install cf-cli

Debian and Ubuntu based Linux distributions:

# ...first add the Cloud Foundry Foundation public key and package repository to your system
$ wget -q -O - https://packages.cloudfoundry.org/debian/cli.cloudfoundry.org.key | sudo apt-key add -
$ echo "deb http://packages.cloudfoundry.org/debian stable main" | sudo tee /etc/apt/sources.list.d/cloudfoundry-cli.list
# ...then, update your local package index, then finally install the cf CLI
$ sudo apt-get update
$ sudo apt-get install cf-cli

Enterprise Linux and Fedora systems (RHEL6/CentOS6 and up):

# ...first configure the Cloud Foundry Foundation package repository
$ sudo wget -O /etc/yum.repos.d/cloudfoundry-cli.repo https://packages.cloudfoundry.org/fedora/cloudfoundry-cli.repo
# ...then, install the cf CLI (which will also download and add the public key to your system)
$ sudo yum install cf-cli

Installers and compressed binaries

Mac OS X 64 bit Windows 64 bit Linux 64 bit
Installers pkg zip rpm / deb
Binaries tgz zip tgz
Release notes, and 32 bit releases can be found here.

Download examples with curl for Mac OS X and Linux binaries

# ...download & extract Mac OS X binary
$ curl -L "https://cli.run.pivotal.io/stable?release=macosx64-binary&source=github" | tar -zx
# ...or Linux 64-bit binary
$ curl -L "https://cli.run.pivotal.io/stable?release=linux64-binary&source=github" | tar -zx
# ...move it to /usr/local/bin or a location you know is in your $PATH
$ mv cf /usr/local/bin
# ...and to confirm your cf CLI version
$ cf --version
cf version x.y.z+...
Edge binaries

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. Follow these download links for Mac OS X 64 bit, Windows 64 bit and Linux 64 bit.

Known Issues

  • In Cygwin and Git Bash on Windows, interactive password prompts (in cf login) do not work (see issue #171). Please use alternative commands (cf api and cf auth to cf login) to work around this.
  • 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 e.g. this Diego-Enabler plugin issue.
  • .cfignore used in cf push must be in UTF8 encoding for CLI to interpret correctly.
  • 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

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

For development guide on writing a cli plugin, see here.

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.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
actor
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
This file was generated by counterfeiter
This file was generated by counterfeiter
v2action
Package v2action contains the business logic for the commands/v2 package
Package v2action contains the business logic for the commands/v2 package
v2action/v2actionfakes
This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter
This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter
v3action
Package v3action contains the business logic for the commands/v3 package
Package v3action contains the business logic for the commands/v3 package
v3action/v3actionfakes
This file was generated by counterfeiter
This file was generated by counterfeiter
api
cloudcontroller
Package cloudcontroller contains shared utilies between the V2 and V3 clients.
Package cloudcontroller contains shared utilies between the V2 and V3 clients.
cloudcontroller/ccv2
Package ccv2 represents a Cloud Controller V2 client.
Package ccv2 represents a Cloud Controller V2 client.
cloudcontroller/ccv2/ccv2fakes
This file was generated by counterfeiter
This file was generated by counterfeiter
cloudcontroller/ccv3
Package ccv3 represents a Cloud Controller V3 client.
Package ccv3 represents a Cloud Controller V3 client.
cloudcontroller/ccv3/ccv3fakes
This file was generated by counterfeiter
This file was generated by counterfeiter
cloudcontroller/cloudcontrollerfakes
This file was generated by counterfeiter
This file was generated by counterfeiter
cloudcontroller/wrapper/wrapperfakes
This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter
This file was generated by counterfeiter This file was generated by counterfeiter This file was 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/noaabridge
Package nooabridge wraps a UAA client and a tokenCache to support the TokenRefresher interface for noaa/consumer.
Package nooabridge wraps a UAA client and a tokenCache to support the TokenRefresher interface for noaa/consumer.
uaa/noaabridge/noaabridgefakes
This file was generated by counterfeiter This file was generated by counterfeiter
This file was generated by counterfeiter This file was generated by counterfeiter
uaa/uaafakes
This file was generated by counterfeiter This file was generated by counterfeiter
This file was generated by counterfeiter This file was generated by counterfeiter
uaa/wrapper/wrapperfakes
This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter
This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter
cf
actors/actorsfakes
This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter
This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter
actors/brokerbuilder/brokerbuilderfakes
This file was generated by counterfeiter
This file was generated by counterfeiter
actors/planbuilder/planbuilderfakes
This file was generated by counterfeiter
This file was generated by counterfeiter
actors/plugininstaller/plugininstallerfakes
This file was generated by counterfeiter
This file was generated by counterfeiter
actors/pluginrepo/pluginrepofakes
This file was generated by counterfeiter
This file was generated by counterfeiter
actors/servicebuilder/servicebuilderfakes
This file was generated by counterfeiter
This file was generated by counterfeiter
actors/userprint/userprintfakes
This file was generated by counterfeiter
This file was generated by counterfeiter
api
api/apifakes
This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter
This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter
api/appevents/appeventsfakes
This file was generated by counterfeiter This file was generated by counterfeiter
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
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
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
This file was generated by counterfeiter This file was generated by counterfeiter
api/applications/applicationsfakes
This file was generated by counterfeiter
This file was generated by counterfeiter
api/authentication/authenticationfakes
This file was generated by counterfeiter This file was generated by counterfeiter
This file was generated by counterfeiter This file was generated by counterfeiter
api/copyapplicationsource/copyapplicationsourcefakes
This file was generated by counterfeiter
This file was generated by counterfeiter
api/environmentvariablegroups/environmentvariablegroupsfakes
This file was generated by counterfeiter
This file was generated by counterfeiter
api/featureflags/featureflagsfakes
This file was generated by counterfeiter
This file was generated by counterfeiter
api/logs/logsfakes
This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter
This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter
api/organizations/organizationsfakes
This file was generated by counterfeiter
This file was generated by counterfeiter
api/password/passwordfakes
This file was generated by counterfeiter
This file was generated by counterfeiter
api/quotas/quotasfakes
This file was generated by counterfeiter
This file was generated by counterfeiter
api/securitygroups/defaults/running/runningfakes
This file was generated by counterfeiter
This file was generated by counterfeiter
api/securitygroups/defaults/staging/stagingfakes
This file was generated by counterfeiter
This file was generated by counterfeiter
api/securitygroups/securitygroupsfakes
This file was generated by counterfeiter
This file was generated by counterfeiter
api/securitygroups/spaces/spacesfakes
This file was generated by counterfeiter
This file was generated by counterfeiter
api/spacequotas/spacequotasfakes
This file was generated by counterfeiter
This file was generated by counterfeiter
api/spaces/spacesfakes
This file was generated by counterfeiter
This file was generated by counterfeiter
api/stacks/stacksfakes
This file was generated by counterfeiter
This file was generated by counterfeiter
appfiles/appfilesfakes
This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter
This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter
cmd
commandregistry/commandregistryfakes
This file was generated by counterfeiter
This file was generated by counterfeiter
commands/application/applicationfakes
This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter
This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter
commands/commandsfakes
This file was generated by counterfeiter
This file was generated by counterfeiter
commands/route/routefakes
This file was generated by counterfeiter
This file was generated by counterfeiter
commands/service/servicefakes
This file was generated by counterfeiter This file was generated by counterfeiter
This file was generated by counterfeiter This file was generated by counterfeiter
commands/user/userfakes
This file was generated by counterfeiter This file was generated by counterfeiter
This file was generated by counterfeiter This file was generated by counterfeiter
configuration/configurationfakes
This file was generated by counterfeiter This file was generated by counterfeiter
This file was generated by counterfeiter This file was generated by counterfeiter
configuration/coreconfig/coreconfigfakes
This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter
This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter
configuration/pluginconfig/pluginconfigfakes
This file was generated by counterfeiter
This file was generated by counterfeiter
errors/errorsfakes
This file was generated by counterfeiter
This file was generated by counterfeiter
manifest/manifestfakes
This file was generated by counterfeiter This file was generated by counterfeiter
This file was generated by counterfeiter This file was generated by counterfeiter
net
net/netfakes
This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter
This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter
requirements/requirementsfakes
This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter
This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter
ssh
ssh/sshfakes
This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter
This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter
ssh/terminal/terminalfakes
This file was generated by counterfeiter
This file was generated by counterfeiter
terminal/terminalfakes
This file was generated by counterfeiter
This file was generated by counterfeiter
trace/tracefakes
This file was generated by counterfeiter
This file was generated by counterfeiter
v3/repository/repositoryfakes
This file was generated by counterfeiter
This file was generated by counterfeiter
Package command should not be imported by external consumers.
Package command should not be imported by external consumers.
commandfakes
This file was generated by counterfeiter This file was generated by counterfeiter
This file was generated by counterfeiter This file was generated by counterfeiter
common
Package common should not be imported by external consumers.
Package common should not be imported by external consumers.
common/commonfakes
This file was generated by counterfeiter
This file was generated by counterfeiter
flag
Package flag should not be imported by external consumers.
Package flag should not be imported by external consumers.
v2
Package v2 should not be imported by external consumers.
Package v2 should not be imported by external consumers.
v2/shared
Package shared should not be imported by external consumers.
Package shared should not be imported by external consumers.
v2/v2fakes
This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter
This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter
v3
Package v3 should not be imported by external consumers.
Package v3 should not be imported by external consumers.
v3/shared
Package shared should not be imported by external consumers.
Package shared should not be imported by external consumers.
v3/v3fakes
This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter
This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter
fixtures
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/call_cli_cmd/main
* * This plugin is an example plugin that allows a user to call a cli-command * by typing `cf cli-command name-of-command args.....`.
* * This plugin is an example plugin that allows a user to call a cli-command * by typing `cf cli-command name-of-command args.....`.
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
This file was generated by counterfeiter
This file was generated by counterfeiter
rpc
rpc/rpcfakes
This file was generated by counterfeiter This file was generated by counterfeiter This file was generated by counterfeiter
This file was generated by counterfeiter This file was generated by counterfeiter This file was 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.
testhelpers/rpcserver/rpcserverfakes
This file was generated by counterfeiter
This file was 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
This file was generated by counterfeiter This file was generated by counterfeiter
This file was generated by counterfeiter This file was generated by counterfeiter
utilfakes
This file was generated by counterfeiter
This file was generated by counterfeiter
words/generator/generatorfakes
This file was generated by counterfeiter
This file was generated by counterfeiter

Jump to

Keyboard shortcuts

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