Current section
6 Versions
Jump to
Current section
6 Versions
Compare versions
16
files changed
+71
additions
-8
deletions
| @@ -4,10 +4,10 @@ A process manager for your `Procfile`(s). | |
| 4 4 | |
| 5 5 | ## Installation |
| 6 6 | |
| 7 | - Add the following to your deps in `mix.env` |
| 7 | + Install the Honcho archive into your Elixir: |
| 8 8 | |
| 9 9 | ```shell |
| 10 | - {:honcho, "~> 0.2"}, |
| 10 | + mix archive.install hex honcho |
| 11 11 | ``` |
| 12 12 | |
| 13 13 | Add a file `Procfile` to your project. Procfiles are defined in the following |
| @@ -17,6 +17,13 @@ format: | |
| 17 17 | <process name>: <command> |
| 18 18 | ``` |
| 19 19 | |
| 20 | + For example: |
| 21 | + |
| 22 | + ```procfile |
| 23 | + postgres: postgres: postgres -D ./_build/data/postgres |
| 24 | + phoenix: mix phx.server |
| 25 | + ``` |
| 26 | + |
| 20 27 | ## Usage |
| 21 28 | |
| 22 29 | Honcho will add several mix tasks your your project, including: |
| @@ -28,3 +35,11 @@ These tasks take the following optional arguments: | |
| 28 35 | |
| 29 36 | * `-p, --procfile` - a path to a Procfile. This defaults to a file, `Procfile`, |
| 30 37 | in the current working directory. |
| 38 | + |
| 39 | + ## Internal dependencies |
| 40 | + |
| 41 | + On starting Honcho, it will attempt to write a bash wrapper script, which |
| 42 | + helps to interface between Erlang and the shell. It will put its internal |
| 43 | + helpers and config into `~/.honcho`. For this reason, in order for Honcho |
| 44 | + to work, `$HOME` must be set, and writeable by the user under which Honcho is |
| 45 | + started. |
| \ No newline at end of file |
| @@ -24,5 +24,5 @@ | |
| 24 24 | {<<"name">>,<<"honcho_supervisor">>}, |
| 25 25 | {<<"optional">>,false}, |
| 26 26 | {<<"repository">>,<<"hexpm">>}, |
| 27 | - {<<"requirement">>,<<"0.2.0">>}]]}. |
| 28 | - {<<"version">>,<<"0.2.0">>}. |
| 27 | + {<<"requirement">>,<<"0.2.1">>}]]}. |
| 28 | + {<<"version">>,<<"0.2.1">>}. |
| @@ -1,8 +1,9 @@ | |
| 1 1 | defmodule Honcho do |
| 2 2 | @moduledoc """ |
| 3 | - Entry point for Honcho |
| 3 | + Entry point for Honcho. |
| 4 4 | """ |
| 5 5 | |
| 6 | + @doc "Entry point for running Honcho as an escript" |
| 6 7 | def main([]), do: Honcho.Output.usage() |
| 7 8 | |
| 8 9 | def main([cmd | args]) do |
| @@ -13,6 +14,7 @@ defmodule Honcho do | |
| 13 14 | |> run(Honcho.Args.parse(args)) |
| 14 15 | end |
| 15 16 | |
| 17 | + @doc "Runs a subcommand module" |
| 16 18 | def run(_, {:error, :parse_args, arg}), |
| 17 19 | do: usage("Unknown option: #{arg}") |
| @@ -1,4 +1,6 @@ | |
| 1 1 | defmodule Honcho.Color do |
| 2 | + @moduledoc false |
| 3 | + |
| 2 4 | @colors %{ |
| 3 5 | black: 0, |
| 4 6 | blue: 4, |
| @@ -1,4 +1,5 @@ | |
| 1 1 | defmodule Honcho.Command do |
| 2 | + @moduledoc false |
| 2 3 | use GenServer |
| 3 4 | |
| 4 5 | alias Honcho.Command.Helpers |
Loading more files…