diff --git a/README.md b/README.md index 9499fc86c..585cdd89d 100644 --- a/README.md +++ b/README.md @@ -202,6 +202,10 @@ Build or rebuild services. Services are built once and then tagged as `project_service`, e.g. `figtest_db`. If you change a service's `Dockerfile` or the contents of its build directory, you can run `fig build` to rebuild it. +#### help + +Get help on a command. + #### kill Force stop service containers. diff --git a/fig/cli/main.py b/fig/cli/main.py index b7a84fa3d..939146e16 100644 --- a/fig/cli/main.py +++ b/fig/cli/main.py @@ -76,6 +76,7 @@ class TopLevelCommand(Command): Commands: build Build or rebuild services + help Get help on a command kill Kill containers logs View output from containers ps List containers @@ -103,6 +104,17 @@ class TopLevelCommand(Command): """ self.project.build(service_names=options['SERVICE']) + def help(self, options): + """ + Get help on a command. + + Usage: help COMMAND + """ + command = options['COMMAND'] + if not hasattr(self, command): + raise NoSuchCommand(command, self) + raise SystemExit(getdoc(getattr(self, command))) + def kill(self, options): """ Force stop service containers.