Skip to content
This repository has been archived by the owner on Jan 28, 2022. It is now read-only.

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
sclevine committed Dec 8, 2016
1 parent d50578f commit 5c60fe4
Showing 1 changed file with 16 additions and 14 deletions.
30 changes: 16 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,29 +8,31 @@ USAGE:
cf local SUBCOMMAND
SUBCOMMANDS:
stage [-b <buildpack URL>] <name> Build a droplet from the app in the
current directory and local.yml.
pull <name> Download the droplet for the named app
and update local.yml with its settings.
run [-p <port>] <name> Run a droplet using the settings
specified in local.yml.
export [-r <reference>] <name> Export a droplet as a Docker image using
the settings specified in local.yml.
help Output this help text.
version Output the CF Local version.
stage [-b <buildpack URL>] <name> Build a droplet from the app in the
current directory and local.yml.
pull <name> Download the droplet for the named app
and update local.yml with its settings.
run [-p <port>] [-d <app-dir>] <name> Run a droplet using the settings
specified in local.yml.
export [-r <reference>] <name> Export a droplet as a Docker image using
the settings specified in local.yml.
help Output this help text.
version Output the CF Local version.
```

CF Local uses Docker to build and run Cloud Foundry apps locally.
CF Local also supports downloading apps (droplets & settings) from a full CF installation.
CF Local:
- Uses Docker to build and run Cloud Foundry apps locally.
- Supports downloading apps (droplets & settings) from a full CF installation.
- Supports mounting an empty (or non-existent) local directory to /home/vcap/app that recieves the staged app.
- Supports mounting a non-empty local directory to /home/vcap/app that replaces the staged app.

App settings (currently env vars and a start command) are downloaded to or manually specified in ./local.yml.
If no buildpack is specified during staging, the latest standard CF buildpacks are used to detect and compile your app.

TODO:
- `cf local push` - upload apps to a CF installation
- Support for mounting a local directory in the app container to allow for faster iteration.
- Improved support for connecting to local services via `VCAP_SERVICES`
- Improved support for connecting to CF app services via `cf ssh` tunnel
- Improved support for connecting to CF services via `cf ssh` tunnel
- Memory quotas, disk quotas, and multiple app instances
- Support for running multiple apps in the same command
- Support for running apps in the background
Expand Down

0 comments on commit 5c60fe4

Please sign in to comment.