README
¶
Cloud Foundry CLI 
This is the official command line client for Cloud Foundry.
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.
$ cd [my-app-directory]
$ cf api api.[my-cloudfoundry].com
Setting api endpoint to https://api.[my-cloudfoundry].com...
OK
$ cf login
API endpoint: https://api.[my-cloudfoundry].com
Email> [my-email]
Password> [my-password]
Authenticating...
OK
$ cf push
#Further Reading and Getting Help
- You can find further documentation at the docs page for the CLI here.
- There is also help available in the CLI itself; type
cf help
for more information. - Each command also has help output available via
cf [command] --help
orcf [command] -h
. - For development guide on writing a cli plugin, see here.
- Finally, if you are still stuck or have any questions or issues, feel free to open a GitHub issue.
Downloads
WARNING: Edge binaries are published 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.
Stable Installers | Stable Binaries | Edge Binaries |
---|---|---|
Mac OS X 64 bit | Mac OS X 64 bit | Mac OS X 64 bit |
Windows 32 bit | Windows 32 bit | Windows 32 bit |
Windows 64 bit | Windows 64 bit | Windows 64 bit |
Redhat 32 bit | Linux 32 bit | Linux 32 bit |
Redhat 64 bit | Linux 64 bit | Linux 64 bit |
Debian 32 bit | ||
Debian 64 bit |
Experimental: Install CF for OSX through Homebrew via the pivotal's homebrew-tap:
$ brew tap pivotal/tap
$ brew install cloudfoundry-cli
Releases: Information about our releases can be found here
Troubleshooting / FAQs
Known Issues
- .cfignore used in
cf push
must be in UTF8 encoding for CLI to interpret correctly.
Linux
- "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 Bugs
- the command you ran
- what occurred
- what you expected to occur
- the command you ran
- the trace output
- a high-level description of the bug
- the command you ran
- the stack trace generated (if any)
- any other relevant information
Forking the repository for development
- Install Go
- Ensure your $GOPATH is set correctly
- Install godep
- Get the cli source code:
go get github.com/cloudfoundry/cli
- (Ignore any warnings about "no buildable Go source files")
- Run
godep restore
(note: this will modify the dependencies in your $GOPATH) - Fork the repository
- Add your fork as a remote:
cd $GOPATH/src/github.com/cloudfoundry/cli && git remote add your_name https://github.com/your_name/cli
Building
To prepare your build environment, run go get github.com/jteeuwen/go-bindata/...
- Run
./bin/build
- The binary will be built into the
./out
directory.
Optionally, you can use bin/run
to compile and run the executable in one step.
If you want to run the tests with ginkgo
, or build with go build
you should first run bin/generate-language-resources
. bin/build
and bin/test
generate language files automatically.
Developing
- Install Mercurial
- Run
go get golang.org/x/tools/cmd/vet
- Write a Ginkgo test.
- Run
bin/test
and watch the test fail. - Make the test pass.
- Submit a pull request to the
master
branch.
* For development guide on writing a cli plugin, see here
Contributing
Major new feature proposals are given as a publically viewable google document with commenting allowed and discussed on the vcap-dev mailing list.
Pull Requests
Pull Requests should be made against the master
branch.
Architecture overview
A command is a struct that implements this interface:
type Command interface {
MetaData() CommandMetadata
SetDependency(deps Dependency, pluginCall bool) Command
Requirements(requirementsFactory requirements.Factory, context flags.FlagContext) (reqs []requirements.Requirement, err error)
Execute(context flags.FlagContext)
}
Metadata()
is just a description of the command name, usage and flags:
type CommandMetadata struct {
Name string
ShortName string
Usage string
Description string
Flags map[string]flags.FlagSet
SkipFlagParsing bool
TotalArgs int
}
Requirements()
returns a list of requirements that need to be met before a command can be invoked.
Execute()
is the method that your command implements to do whatever it's supposed to do. The context
object
provides flags and arguments.
When the command is run, it communicates with api using repositories (they are in cf/api
).
SetDependency()
is where a command obtains its dependencies. Dependencies are typically declared as an interface type, and not a concrete type, so tests can inject a fake.
The bool argument pluginCall
indicates whether the command is invoked by one of the CLI's plugin API methods.
Dependencies are injected into each command, so tests can inject a fake. This means that dependencies are
typically declared as an interface type, and not a concrete type. (see cf/command_registry/dependency.go
)
Some dependencies are managed by a repository locator in cf/api/repository_locator.go
.
Repositories communicate with the api endpoints through a Gateway (see cf/net
).
Models are data structures related to Cloud Foundry (see cf/models
). For example, some models are
apps, buildpacks, domains, etc.
Managing dependencies
Command dependencies are managed by the command registry package. The app uses the package (in cf/command_registry/dependency.go
)to instantiate them, this allows not sharing the knowledge of their dependencies with the app itself.
For commands that use another command as dependency, command_registry
is used for retrieving the command dependency. For example, the command restart
has a dependency on command start
and stop
, and this is how the command dependency is retrieved: restart.go
As for repositories, we use the repository locator to handle their dependencies. You can find it in cf/api/repository_locator.go
.
Example command
Create Space is a good example of a command. Its tests include checking arguments, requiring the user
to be logged in, and the actual behavior of the command itself. You can find it in cf/commands/space/create_space.go
.
i18n
All pull requests which include user-facing strings should include updated translation files. These files are generated/ maintained using i18n4go.
To add/ update translation strings run the command i18n4go -c fixup
. For each change or update, you will be presented with the choices new
or upd
. Type in the appropriate choice. If upd
is chosen, you will be asked to confirm which string is being updated using a numbered list.
Current conventions
Creating Commands
Resources that include several commands have been broken out into their own sub-package using the Resource name. An example of this convention is the Space resource and package (see cf/commands/space
)
In addition, command file and methods naming follows a CRUD like convention. For example, the Space resource includes commands such a CreateSpace, ListSpaces, DeleteSpace, etc.
Creating Repositories
Although not ideal, we use the name "Repository" for API related operations as opposed to "Service". Repository was chosen to avoid confusion with Service model objects (i.e. creating Services and Service Instances within Cloud Foundry).
By convention, Repository methods return a model object and an error. Models are used in both Commands and Repositories to model Cloud Foundry data. This convention provides a consistent method signature across repositories.
Directories
¶
Path | Synopsis |
---|---|
Godeps
|
|
_workspace/src/github.com/Sirupsen/logrus
Package logrus is a structured logger for Go, completely API compatible with the standard library logger.
|
Package logrus is a structured logger for Go, completely API compatible with the standard library logger. |
_workspace/src/github.com/cloudfoundry-incubator/cli-plugin-repo/models/fakes
This file was generated by counterfeiter
|
This file was generated by counterfeiter |
_workspace/src/github.com/cloudfoundry-incubator/diego-ssh/cf-plugin/terminal/terminal_helper_fakes
This file was generated by counterfeiter
|
This file was generated by counterfeiter |
_workspace/src/github.com/cloudfoundry-incubator/diego-ssh/keys/fake_keys
This file was generated by counterfeiter
|
This file was generated by counterfeiter |
_workspace/src/github.com/cloudfoundry-incubator/diego-ssh/server/fakes
This file was generated by counterfeiter
|
This file was generated by counterfeiter |
_workspace/src/github.com/cloudfoundry-incubator/diego-ssh/test_helpers/fake_io
This file was generated by counterfeiter
|
This file was generated by counterfeiter |
_workspace/src/github.com/cloudfoundry-incubator/diego-ssh/test_helpers/fake_net
This file was generated by counterfeiter
|
This file was generated by counterfeiter |
_workspace/src/github.com/cloudfoundry-incubator/diego-ssh/test_helpers/fake_ssh
This file was generated by counterfeiter
|
This file was generated by counterfeiter |
_workspace/src/github.com/cloudfoundry/loggregator_consumer
Package loggregator_consumer provides a simple, channel-based API for clients to communicate with loggregator servers.
|
Package loggregator_consumer provides a simple, channel-based API for clients to communicate with loggregator servers. |
_workspace/src/github.com/cloudfoundry/sonde-go/events
Package events is a generated protocol buffer package.
|
Package events is a generated protocol buffer package. |
_workspace/src/github.com/docker/docker/pkg/term
Package term provides provides structures and helper functions to work with terminal (state, sizes).
|
Package term provides provides structures and helper functions to work with terminal (state, sizes). |
_workspace/src/github.com/gogo/protobuf/proto
Package proto converts data structures to and from the wire format of protocol buffers.
|
Package proto converts data structures to and from the wire format of protocol buffers. |
_workspace/src/github.com/golang/protobuf/proto
Package proto converts data structures to and from the wire format of protocol buffers.
|
Package proto converts data structures to and from the wire format of protocol buffers. |
_workspace/src/github.com/golang/protobuf/proto/proto3_proto
Package proto3_proto is a generated protocol buffer package.
|
Package proto3_proto is a generated protocol buffer package. |
_workspace/src/github.com/gorilla/websocket
Package websocket implements the WebSocket protocol defined in RFC 6455.
|
Package websocket implements the WebSocket protocol defined in RFC 6455. |
_workspace/src/github.com/gorilla/websocket/examples/autobahn
Command server is a test server for the Autobahn WebSockets Test Suite.
|
Command server is a test server for the Autobahn WebSockets Test Suite. |
_workspace/src/github.com/kr/pty
Package pty provides functions for working with Unix terminals.
|
Package pty provides functions for working with Unix terminals. |
_workspace/src/github.com/nicksnyder/go-i18n/i18n
Package i18n supports string translations with variable substitution and CLDR pluralization.
|
Package i18n supports string translations with variable substitution and CLDR pluralization. |
_workspace/src/github.com/nicksnyder/go-i18n/i18n/bundle
Package bundle manages translations for multiple languages.
|
Package bundle manages translations for multiple languages. |
_workspace/src/github.com/nicksnyder/go-i18n/i18n/language
Package language defines languages that implement CLDR pluralization.
|
Package language defines languages that implement CLDR pluralization. |
_workspace/src/github.com/nicksnyder/go-i18n/i18n/translation
Package translation defines the interface for a translation.
|
Package translation defines the interface for a translation. |
_workspace/src/github.com/onsi/ginkgo
Ginkgo is a BDD-style testing framework for Golang
|
Ginkgo is a BDD-style testing framework for Golang |
_workspace/src/github.com/onsi/ginkgo/config
Ginkgo accepts a number of configuration options.
|
Ginkgo accepts a number of configuration options. |
_workspace/src/github.com/onsi/ginkgo/ginkgo
The Ginkgo CLI
|
The Ginkgo CLI |
_workspace/src/github.com/onsi/ginkgo/reporters
Ginkgo's Default Reporter
|
Ginkgo's Default Reporter |
_workspace/src/github.com/onsi/gomega
Gomega is the Ginkgo BDD-style testing framework's preferred matcher library.
|
Gomega is the Ginkgo BDD-style testing framework's preferred matcher library. |
_workspace/src/github.com/onsi/gomega/format
Gomega's format package pretty-prints objects.
|
Gomega's format package pretty-prints objects. |
_workspace/src/github.com/onsi/gomega/gbytes
Package gbytes provides a buffer that supports incrementally detecting input.
|
Package gbytes provides a buffer that supports incrementally detecting input. |
_workspace/src/github.com/onsi/gomega/gexec
Package gexec provides support for testing external processes.
|
Package gexec provides support for testing external processes. |
_workspace/src/github.com/onsi/gomega/ghttp
Package ghttp supports testing HTTP clients by providing a test server (simply a thin wrapper around httptest's server) that supports registering multiple handlers.
|
Package ghttp supports testing HTTP clients by providing a test server (simply a thin wrapper around httptest's server) that supports registering multiple handlers. |
_workspace/src/github.com/onsi/gomega/ghttp/protobuf
Package protobuf is a generated protocol buffer package.
|
Package protobuf is a generated protocol buffer package. |
_workspace/src/github.com/onsi/gomega/matchers
Gomega matchers
|
Gomega matchers |
_workspace/src/golang.org/x/crypto/ssh
Package ssh implements an SSH client and server.
|
Package ssh implements an SSH client and server. |
_workspace/src/golang.org/x/crypto/ssh/agent
Package agent implements a client to an ssh-agent daemon.
|
Package agent implements a client to an ssh-agent daemon. |
_workspace/src/golang.org/x/crypto/ssh/terminal
Package terminal provides support functions for dealing with terminals, as commonly found on UNIX systems.
|
Package terminal provides support functions for dealing with terminals, as commonly found on UNIX systems. |
_workspace/src/golang.org/x/crypto/ssh/test
This package contains integration tests for the golang.org/x/crypto/ssh package.
|
This package contains integration tests for the golang.org/x/crypto/ssh package. |
_workspace/src/golang.org/x/net/websocket
Package websocket implements a client and server for the WebSocket protocol as specified in RFC 6455.
|
Package websocket implements a client and server for the WebSocket protocol as specified in RFC 6455. |
_workspace/src/gopkg.in/yaml.v2
Package yaml implements YAML support for the Go language.
|
Package yaml implements YAML support for the Go language. |
actors/broker_builder/fakes
This file was generated by counterfeiter
|
This file was generated by counterfeiter |
actors/fakes
This file was generated by counterfeiter
|
This file was generated by counterfeiter |
actors/plan_builder/fakes
This file was generated by counterfeiter
|
This file was generated by counterfeiter |
actors/plugin_repo/fakes
This file was generated by counterfeiter
|
This file was generated by counterfeiter |
actors/service_builder/fakes
This file was generated by counterfeiter
|
This file was generated by counterfeiter |
api/app_events/fakes
This file was generated by counterfeiter
|
This file was generated by counterfeiter |
api/app_files/fakes
This file was generated by counterfeiter
|
This file was generated by counterfeiter |
api/app_instances/fakes
This file was generated by counterfeiter
|
This file was generated by counterfeiter |
api/application_bits/fakes
This file was generated by counterfeiter
|
This file was generated by counterfeiter |
api/copy_application_source/fakes
This file was generated by counterfeiter
|
This file was generated by counterfeiter |
api/environment_variable_groups/fakes
This file was generated by counterfeiter
|
This file was generated by counterfeiter |
api/fakes
This file was generated by counterfeiter
|
This file was generated by counterfeiter |
api/feature_flags/fakes
This file was generated by counterfeiter
|
This file was generated by counterfeiter |
api/organizations/fakes
This file was generated by counterfeiter
|
This file was generated by counterfeiter |
api/quotas/fakes
This file was generated by counterfeiter
|
This file was generated by counterfeiter |
api/security_groups/defaults/running/fakes
This file was generated by counterfeiter
|
This file was generated by counterfeiter |
api/security_groups/defaults/staging/fakes
This file was generated by counterfeiter
|
This file was generated by counterfeiter |
api/security_groups/fakes
This file was generated by counterfeiter
|
This file was generated by counterfeiter |
api/security_groups/spaces/fakes
This file was generated by counterfeiter
|
This file was generated by counterfeiter |
api/space_quotas/fakes
This file was generated by counterfeiter
|
This file was generated by counterfeiter |
api/stacks/fakes
This file was generated by counterfeiter
|
This file was generated by counterfeiter |
app_files/fakes
This file was generated by counterfeiter
|
This file was generated by counterfeiter |
configuration/fakes
This file was generated by counterfeiter
|
This file was generated by counterfeiter |
configuration/plugin_config/fakes
This file was generated by counterfeiter
|
This file was generated by counterfeiter |
i18n/detection/fakes
This file was generated by counterfeiter
|
This file was generated by counterfeiter |
manifest/fakes
This file was generated by counterfeiter
|
This file was generated by counterfeiter |
net/fakes
This file was generated by counterfeiter
|
This file was generated by counterfeiter |
ssh/fakes
This file was generated by counterfeiter
|
This file was generated by counterfeiter |
ssh/terminal/terminal_helper_fakes
This file was generated by counterfeiter
|
This file was generated by counterfeiter |
terminal/fakes
This file was generated by counterfeiter
|
This file was generated by counterfeiter |
fixtures
|
|
fakes
This file was generated by counterfeiter
|
This file was generated by counterfeiter |
rpc/fakes
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.....`. |
testhelpers
|
|
commands
This file was generated by counterfeiter
|
This file was generated by counterfeiter |
rpc_server/fakes
This file was generated by counterfeiter
|
This file was generated by counterfeiter |
fakes
This file was generated by counterfeiter
|
This file was generated by counterfeiter |
generator/fakes
This file was generated by counterfeiter
|
This file was generated by counterfeiter |