UNPKG

1.4 kBMarkdownView Raw
1heroku-local [![Circle CI](https://circleci.com/gh/heroku/heroku-local/tree/master.svg?style=svg)](https://circleci.com/gh/heroku/heroku-local/tree/master)
2============
3
4[![Code Climate](https://codeclimate.com/github/heroku/heroku-local/badges/gpa.svg)](https://codeclimate.com/github/heroku/heroku-local)
5[![npm version](https://badge.fury.io/js/heroku-local.svg)](https://badge.fury.io/js/heroku-local)
6[![License](https://img.shields.io/github/license/heroku/heroku-local.svg)](https://github.com/heroku/heroku-local/blob/master/LICENSE)
7
8[![js-standard-style](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard)
9
10Run heroku apps locally. This plugin is built into the Heroku Toolbelt, you do not need to install it separately.
11
12To use:
13
14```
15$ heroku local
1612:47:17 PM web.1 | listening on 3000
17```
18
19This command internally uses [node-foreman](https://github.com/strongloop/node-foreman) to run the app locally.
20
21Help
22=======
23
24```
25$ heroku help local
26
27Usage: heroku local [PROCESSNAME]
28
29 run heroku app locally
30
31 Start the application specified by a Procfile (defaults to ./Procfile)
32
33 Examples:
34
35 heroku local
36 heroku local web
37 heroku local -f Procfile.test -e .env.test
38
39 -f, --procfile PROCFILE
40 -e, --env ENV
41 -p, --port PORT
42
43Additional commands, type "heroku help COMMAND" for more details:
44
45 local:version # display node-foreman version
46```