• This repository has been archived on 26/Jan/2022
  • Stars
    star
    377
  • Rank 113,535 (Top 3 %)
  • Language
    Ruby
  • License
    Apache License 2.0
  • Created over 13 years ago
  • Updated over 11 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

The command line client for Cloud Foundry - the open platform as a service project

Build Status Gem Version Code Climate

The vmc tool only supports v1 Cloud Foundry and is deprecated for v2.

For v2, vmc and its plugins have been renamed to cf. You can find the current version of the code for this gem at http://github.com/cloudfoundry/cf

CLI for Cloud Foundry (compatible with v1 only)

The CLI for Cloud Foundry is being completely rewritten. Installation, usage & contribution instructions are below.

To use this CLI, your Cloud Foundry installation must be running the v1 cloud controller.

Installation

$ gem install vmc
$ vmc -v
vmc 0.4.2

Development

$ git clone [email protected]:cloudfoundry/vmc.git
$ cd vmc
$ bundle install
$ rake gem:install

Usage

$ vmc help --all
Getting Started
  info            	Display information on the current target, user, etc.
  target [URL]    	Set or display the target cloud, organization, and space
  targets         	List known targets.
  login [USERNAME]	Authenticate with the target
  logout          	Log out from the target
  register [EMAIL]	Create a user and log in
  colors          	Show color configuration

Applications
  app [APP]	Show app information
  apps     	List your applications

  Management
    delete APPS...     	Delete an application
    push [NAME]        	Push an application, syncing changes if it exists
    rename [APP] [NAME]	Rename an application
    restart APPS...    	Stop and start an application
    start APPS...      	Start an application
    stop APPS...       	Stop an application

  Information
    crashes APPS...         	List an app's crashed instances
    env [APP]               	Show all environment variables set for an app
    set-env APP NAME [VALUE]	Set an environment variable
    unset-env APP NAME      	Remove an environment variable
    file APP [PATH]         	Print out an app's file contents
    files APP [PATH]        	Examine an app's files
    tail APP [PATH]         	Stream an app's file contents
    health APPS...          	Get application health
    instances APPS...       	List an app's instances
    logs [APP]              	Print out an app's logs
    crashlogs APP           	Print out the logs for an app's crashed instances
    map APP URL             	Add a URL mapping for an app
    unmap APP [URL]         	Remove a URL mapping from an app
    scale [APP]             	Update the instances/memory limit for an application
    stats [APP]             	Display application instance status

Services
  service INSTANCE	Show service instance information
  services        	List your service instances

  Management
    bind-service [INSTANCE] [APP]  	Bind a service instance to an application
    unbind-service [INSTANCE] [APP]	Unbind a service from an application
    create-service [SERVICE] [NAME]	Create a service
    delete-service [INSTANCE]      	Delete a service
    rename-service [SERVICE] [NAME]	Rename a service
    tunnel [INSTANCE] [CLIENT]     	Tells you to install tunnel-vmc-plugin

Organizations
  create-org [NAME]               	Create an organization
  delete-org [ORGANIZATION]       	Delete an organization
  org [ORGANIZATION]              	Show organization information
  orgs                            	List available organizations
  rename-org [ORGANIZATION] [NAME]	Rename an organization

Spaces
  create-space [NAME] [ORGANIZATION]	Create a space in an organization
  delete-space SPACES...            	Delete a space and its contents
  rename-space [SPACE] [NAME]       	Rename a space
  space [SPACE]                     	Show space information
  spaces [ORGANIZATION]             	List spaces in an organization
  take-space NAME                   	Switch to a space, creating it if it doesn't exist

Routes
  create-route [URL]  	Create a route
  delete-route [ROUTE]	Delete a route
  routes              	List routes in a space

Domains
  add-domain NAME       	Add a domain to a space
  create-domain NAME    	Create a domain
  delete-domain [DOMAIN]	Delete a domain
  domains [SPACE]       	List domains in a space
  remove-domain [DOMAIN]	Remove a domain from a space

Administration
  users	List all users

  User Management
    create-user [EMAIL]	Create a user
    delete-user EMAIL  	Delete a user
    passwd [USER]      	Update a user's password

Options:
      --[no-]color       Use colorful output
      --[no-]script      Shortcut for --quiet and --force
  -V, --verbose          Print extra information
  -f, --[no-]force       Skip interaction when possible
  -h, --help             Show command usage & instructions
  -m, --manifest FILE    Path to manifest file to use
  -q, --[no-]quiet       Simplify output format
  -t, --trace            Show API requests and responses
  -u, --proxy EMAIL      Run this command as another user (admin only)
  -v, --version          Print version number

Cloud Foundry Resources

Cloud Foundry Open Source Platform as a Service

Learn

Our documentation, currently a work in progress, is available here: http://cloudfoundry.github.com/

Ask Questions

Questions about the Cloud Foundry Open Source Project can be directed to our Google Groups.

File a bug

Bugs can be filed using Github Issues within the various repositories of the Cloud Foundry components.

OSS Contributions

The Cloud Foundry team uses GitHub and accepts contributions via pull request

Follow these steps to make a contribution to any of our open source repositories:

  1. Complete our CLA Agreement for individuals or corporations

  2. Set your name and email

    git config --global user.name "Firstname Lastname" git config --global user.email "[email protected]"

Fork the repo

Make your changes on a topic branch, commit, and push to github and open a pull request.

Once your commits are approved by Travis CI and reviewed by the core team, they will be merged.

More Repositories

1

vcap

Cloud Foundry - the open platform as a service project
Ruby
1,324
star
2

lattice-release

Lattice
Go
747
star
3

cf-release

Deprecated: Cloud Foundry Release
Shell
576
star
4

bosh-lite

A lite development env for BOSH
Shell
319
star
5

warden

Cloud Foundry - the open platform as a service project
Ruby
281
star
6

vcap-services

Cloud Foundry - the open platform as a service project
Ruby
276
star
7

cfdev

A fast and easy local Cloud Foundry experience on native hypervisors, powered by LinuxKit with VPNKit
Go
227
star
8

oss-docs

Documentation for the Cloud Foundry Platform as a Service
Shell
139
star
9

cf-abacus

CF usage metering and aggregation
JavaScript
98
star
10

vblob

JavaScript
64
star
11

bosh-notes

Collection of proposals for BOSH
Ruby
51
star
12

cf-docs

A well lit place for docs
CSS
46
star
13

garden-linux

Garden with a linux backend
Go
44
star
14

eclipse-integration-cloudfoundry

Cloud Foundry Integration for Eclipse
Java
41
star
15

hm9000

Go
40
star
16

jibber_jabber

Cross Platform locale detection for Golang
Go
39
star
17

dea_ng

Droplet Execution Agent for Cloud Foundry v2
Ruby
34
star
18

login-server

Cloud Foundry Login Server
Java
32
star
19

health_manager

Cloud Foundry - the open platform as a service project
Ruby
32
star
20

bosh-init

bosh-init is a tool used to create and update the Director VM
Go
31
star
21

istio-release

DEPRECATED: Istio + Cloud Foundry
Shell
29
star
22

vcap-test-assets

Cloud Foundry - the open platform as a service project
Ruby
24
star
23

garden-windows

Garden with a windows backend
C#
24
star
24

router

Cloud Foundry - the open platform as a service project
Ruby
23
star
25

bosh-workspace

Gem for managing your bosh workspace
Ruby
22
star
26

cf-openstack-validator

This repository is UNMAINTAINED.
Ruby
21
star
27

cf-networking-examples

Go
21
star
28

cf-swagger

Collection of Swagger descriptions and applications for CloudFoundry BOSH
Go
21
star
29

cf-mysql-broker

CSS
20
star
30

gonit

gonit
Go
19
star
31

cf

The Cloud Foundry command-line interface
Ruby
19
star
32

cf-dotnet-sdk

Cloud Foundry .NET SDK
C#
18
star
33

cloud_controller

Ruby
18
star
34

bosh-ext-cli

CLI that includes additional set of commands for interacting with BOSH and release authoring
Go
18
star
35

micro

Micro Cloud Foundry
Ruby
17
star
36

cf-docs-cn

Chinese translation of V1 docs
CSS
17
star
37

caldecott

Ruby
16
star
38

gonats

A Go NATS Client
Go
16
star
39

Diego-Enabler

A CF CLI plugin to help you migrate apps from the DEA to Diego runtime
Go
15
star
40

vcap-yeti

Cloud Foundry - the open platform as a service project
Ruby
15
star
41

dea

Ruby
14
star
42

mega-ci

Scripts, templates, and configuration for the CF Infrastructure team's CI pipelines
Shell
13
star
43

networking-release

CF-BOSH Release containing several jobs to configure VM networking
Shell
13
star
44

vcap-node

Cloud Foundry - the open platform as a service project
JavaScript
13
star
45

vcap-tools

Java
12
star
46

multi-buildpack

Cloud Foundry buildpack for running multiple buildpacks
Go
12
star
47

cf-app-sd-release

Service Discovery for CloudFoundry
Go
12
star
48

cf-docs-deprecated

JavaScript
12
star
49

mssql-server-broker

Cloud Foundry service broker for Microsoft SQL Server
Java
12
star
50

vcap-staging

Cloud Foundry - the open platform as a service project
Ruby
12
star
51

cfoundry

Cloud Foundry REST API gem
Ruby
12
star
52

acm

Ruby
11
star
53

bosh-openstack-environment-templates

This repository is UNMAINTAINED, please consider https://github.com/cloudfoundry/bosh-bootloader to deploy BOSH on OpenStack
HCL
11
star
54

IronFrame

Windows Container library
C#
11
star
55

wats

Windows Acceptance Tests
Go
10
star
56

cf-logmon

Kotlin
10
star
57

cf-vs-extension

Cloud Foundry Visual Studio Extension
C#
10
star
58

firehose-plugin

Cloud Foundry CLI plugin to connect to the firehose
Go
10
star
59

consul-release

This is a BOSH release for consul.
Go
10
star
60

brooklyn-plugin

A CLI Plugin for Cloud Foundry for use with Brooklyn Service Broker
Go
10
star
61

cephfs-bosh-release

Shell
10
star
62

scalable-syslog

Go
10
star
63

common

Ruby
10
star
64

vcap-services-base

Ruby
9
star
65

cf-windows-prison

A library that aims to faciliate a multi-tenant secure environment on Microsoft Windows Server.
C#
9
star
66

cf-riak-cs-release

A BOSH release for riak and riak-cs
Shell
9
star
67

stac2

Load test system for cloudfoundry
JavaScript
9
star
68

apache-brooklyn-service-broker

A Cloud Foundry Service Broker for Apache Brooklyn
Java
9
star
69

vcap-ruby

Ruby
9
star
70

cf-deployment-transition

This repository is deprecated - no longer accepting PR's or Issues
Shell
9
star
71

datadog-firehose-nozzle

OBSOLETE CF component to forward metrics from the Loggregator Firehose to DataDog
Go
9
star
72

receptor

restful api facade for diego
Go
8
star
73

cf-mssql-broker

A Go broker for MSSQL Service
Go
8
star
74

cf-networking-notes

HTML
8
star
75

oss-release

Shell
8
star
76

tools-cf-plugin

Ruby
8
star
77

cloudfoundry.org

CSS
8
star
78

windows_app_lifecycle

C#
8
star
79

storeadapter

Golang interface for ETCd/zookeeper style datastores
Go
8
star
80

gonatsd

Go
7
star
81

cf_canaries

A gem for installing canary apps in a CloudFoundry installation
Ruby
7
star
82

cloudfoundry-buildpack-clr

Cloud Foundry buildpack for CLR frameworks like ASP.NET and .NET standalone apps
Ruby
6
star
83

stager

Cloud Foundry - the open platform as a service project
Ruby
6
star
84

bosh-photon-cpi-release

Go
6
star
85

loggregator-k8s-deployment

A deployment of loggregator on kubernetes
Shell
6
star
86

vmc-lib

Cloud Foundry - the open platform as a service project
Ruby
6
star
87

stager-client

Cloud Foundry - the open platform as a service project
Ruby
6
star
88

nyet

not yeti
Ruby
5
star
89

bosh-packer-templates

Shell
5
star
90

collector

(DEPRECATED) Cloud Foundry Metric Collector
Ruby
5
star
91

errors

Shared error codes and messages for Cloud Foundry
5
star
92

oss-tools

Ruby
5
star
93

vcap-concurrency

Ruby
5
star
94

gamble

A go wrapper around libyaml
C
5
star
95

go_cfmessagebus

Wrapper to Message Bus for CF, currently NATS.
Go
5
star
96

diego-cli-plugin

Go
5
star
97

api-deprecated

Experimental CF API server written in GO
C
5
star
98

dea-hm-workspace

This is a go workspace for the health manager and its dependencies
Shell
5
star
99

cf-abacus-broker

A broker for the CF-Abacus project with associated UI and other artifacts
JavaScript
5
star
100

cf-mongodb-example-app

MongoDB Example Application
Ruby
5
star