stow/oh-my-zsh/.oh-my-zsh/plugins/cloudfoundry/README.md

   1 # Cloudfoundry Plugin
   2
   3 This plugin is intended to offer a few simple aliases for regular users of the [Cloud Foundry Cli][1]. Most are just simple aliases that will save a bit of typing. Others include mini functions and or accept parameters. Take a look at the table below for details.
   4
   5 | Alias    | Command                     | Description                                                              |
   6 |----------|-----------------------------|--------------------------------------------------------------------------|
   7 | cfl      | `cf login`                  | Login to Cloud Foundry                                                   |
   8 | cft      | `cf target`                 | Target the cli at a specific Org/Space in Cloud Foundry                  |
   9 | cfa      | `cf apps`                   | List all applications in the current Org/Space                           |
  10 | cfs      | `cf services`               | List all services in the current Org/Space                               |
  11 | cfm      | `cf marketplace`            | List the services available in the Marketplace                           |
  12 | cfp      | `cf push`                   | Push your application code to Cloud Foundry                              |
  13 | cfcs     | `cf create-service`         | Create a service based on a Marketplace offering                         |
  14 | cfbs     | `cf bind-service`           | Bind an application to a service you created                             |
  15 | cfus     | `cf unbind-service`         | Unbind a service from an application                                     |
  16 | cfds     | `cf delete-service`         | Delete a service you no longer have bound                                |
  17 | cfup     | `cf cups`                   | Create a "user-provided-service"                                         |
  18 | cflg     | `cf logs`                   | Tail the logs of an application (requires <APP_NAME>)                    |
  19 | cfr      | `cf routes`                 | List all the routes in the current Space                                 |
  20 | cfe      | `cf env`                    | Show the environment variables for an application (requires <APP_NAME>)  |
  21 | cfsh     | `cf ssh`                    | Attach to a running container (requires an <APP_NAME> etc.)              |
  22 | cfsc     | `cf scale`                  | Scale an application (requires an <APP_NAME> etc.)                       |
  23 | cfev     | `cf events`                 | Show the application events (requires <APP_NAME>)                        |
  24 | cfdor    | `cf delete-orphaned-routes` | Delete routes that are no longer bound to applications                   |
  25 | cfbpk    | `cf buildpacks`             | List the available buildpacks                                            |
  26 | cfdm     | `cf domains`                | List the domains associates with this Cloud Foundry foundation           |
  27 | cfsp     | `cf spaces`                 | List all the Spaces in the current Org                                   |
  28 | cfap     | `cf app`                    | Show the details of a deployed application (requires <APP_NAME>)         |
  29 | cfh.     | `export CF_HOME=$PWD/.cf`   | Set the current directory as CF_HOME                                     |
  30 | cfh~     | `export CF_HOME=~/.cf`      | Set the user's root directory as CF_HOME                                 |
  31 | cfhu     | `unset CF_HOME`             | Unsets CF_HOME                                                           |
  32 | cfpm     | `cf push -f`                | Push an application using a manifest (requires <MANIFEST_FILE> location) |
  33 | cflr     | `cf logs --recent`          | Show the recent logs (requires <APP_NAME>)                               |
  34 | cfsrt    | `cf start`                  | Start an application (requires <APP_NAME>)                               |
  35 | cfstp    | `cf stop`                   | Stop an application (requires <APP_NAME>)                                |
  36 | cfstg    | `cf restage`                | Restage an application (requires <APP_NAME>)                             |
  37 | cfdel    | `cf delete`                 | Delete an application (requires <APP_NAME>)                              |
  38 | cfsrtall | -                           | Start all apps that are currently in the "Stopped" state                 |
  39 | cfstpall | -                           | Stop all apps that are currently in the "Started" state                  |
  40
  41 For help and advice on what any of the commands does, consult the built in `cf` help functions as follows:-
  42
  43 ```bash
  44 cf help # List the most popular and commonly used commands
  45 cf help -a # Complete list of all possible commands
  46 cf <COMMAND_NAME> --help # Help on a specific command including arguments and examples
  47 ```
  48
  49 Alternatively, seek out the [online documentation][3]. And don't forget, there are loads of great [community plugins for the cf-cli][4] command line tool that can greatly extend its power and usefulness.
  50
  51 ## Contributors
  52
  53 Contributed to `oh_my_zsh` by [benwilcock][2].
  54
  55 [1]: https://docs.cloudfoundry.org/cf-cli/install-go-cli.html
  56 [2]: https://github.com/benwilcock
  57 [3]: https://docs.cloudfoundry.org/cf-cli/getting-started.html
  58 [4]: https://plugins.cloudfoundry.org/