cloudfoundrycli

command module
v6.22.1+incompatible Latest Latest
Warning

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

Go to latest
Published: Sep 24, 2016 License: Apache-2.0 Imports: 12 Imported by: 0

README

Cloud Foundry CLI Apache License 2.0 Build Status Code Climate

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 run the installer for your platform 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

Latest stable: Download the installer or compressed binary for your platform:

Mac OS X 64 bit Windows 64 bit Linux 64 bit
Installers pkg zip rpm / deb
Binaries tgz zip tgz

From the command line: Download examples with curl for Mac OS X and Linux

# ...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
# ...and to confirm your cf CLI version
$ ./cf --version
cf version x.y.z-...

Via Homebrew: Install CF for OSX through Homebrew via the cloudfoundry tap:

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

Releases: 32 bit releases and information about all our releases can be found here.

Also, edge binaries are published for Mac OS X 64 bit, Windows 64 bit and Linux 64 bit with each new 'push' that passes though CI. These binaries are not intended for wider use; they're for developers to test new features and fixes as they are completed.

Known Issues

  • In Cygwin and Git Bash on Windows, interactive prompts (such as in cf login) do not work (see #171). Please use alternative commands (e.g. cf api and cf auth to cf login) or option -f to suppress the prompts.
  • .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
actors
configactions
Package configactions handles all operations done to the CF Config.
Package configactions handles all operations done to the CF Config.
configactions/configactionsfakes
This file was generated by counterfeiter
This file was generated by counterfeiter
v2actions
Package v2actions contains the business logic for the commands/v2 package
Package v2actions contains the business logic for the commands/v2 package
api
cf
actors/actorsfakes
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
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
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
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
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
api/strategy/strategyfakes
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
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
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
commands/user/userfakes
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
configuration/coreconfig/coreconfigfakes
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
net
net/netfakes
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
ssh
ssh/sshfakes
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
commandsfakes
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
v2
v2/v2fakes
This file was generated by counterfeiter
This file was generated by counterfeiter
fixtures
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 is an example plugin where we use both arguments and flags.
* * This is an example plugin where we use both arguments and flags.
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.....`.
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
testhelpers
io
net
rpcserver/rpcserverfakes
This file was generated by counterfeiter
This file was generated by counterfeiter
config
Package config package contains everything related to the CF CLI Configuration.
Package config package contains everything related to the CF CLI Configuration.
utilsfakes
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