From ddf6fdd87510885f71ce6bbf9cb96736d77419b2 Mon Sep 17 00:00:00 2001 From: Ivaylo Novakov Date: Mon, 13 Dec 2021 11:36:47 +0200 Subject: [PATCH] Add a docstring explaining the `dc` command. --- dc | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/dc b/dc index c041317a..5d21567a 100755 --- a/dc +++ b/dc @@ -1,5 +1,10 @@ #!/bin/bash +# The dc command is an alias to docker-compose which also scans the current portal configuration (as defined in .env) +# and selects the right docker-compose files to include in the operation. You can use the command in the same way you +# would use docker-compose with the only difference being that you don't need to specify compose files. For more +# information you can run `./dc` or `./dc help`. + if [ -f .env ]; then OLD_IFS=$IFS; IFS=$'\n'; for x in `grep -v '^#.*' .env`; do export $x; done; IFS=$OLD_IFS fi