Docs

docs/usage.md

@@ -173,31 +173,6 @@ Exposed port found!
 Finished!
 ```
 
-#### `dalmatian util generate-four-words`
-
-This helpful command can be used to generate passphrases that can be used for limited purposes such as Basic HTTP authentication gates.
-
-> [!Important]
-> This command is not a substitute for good password hygiene. Always follow dxw's official password policy.
-
-Generate a password that is suitable for use in basic auth
-
-```
-$ dalmatian util generate-four-words
-Please note that the phrases generated here should not be used as login
-passwords or to hide secrets. Please use 1Password in those cicumstances.
-If you have any questions, please ask the Technical Operations team for advice.
-
-width-males-minded-random
-```
-
-To suppress the warning, add `-q` to the command
-
-```
-$ dalmatian util generate-four-words -q
-away-naught-wagner-mimic
-```
-
 #### `dalmatian util env`
 
 Print the shell environment variables for a specific infrastructure. You should not expect to need to use this command for anything other than debugging a significant issue with Dalmatian.
@@ -229,6 +204,31 @@ export AWS_EPOCH="$(gdate -d "$AWS_DATE $AWS_TIME $AWS_TZ" +%s)";
 
 You can set the target infrastructure name with `-i` which may adjust the values of some of the data.
 
+#### `dalmatian util generate-four-words`
+
+This helpful command can be used to generate passphrases that can be used for limited purposes such as Basic HTTP authentication gates.
+
+> [!Important]
+> This command is not a substitute for good password hygiene. Always follow dxw's official password policy.
+
+Generate a password that is suitable for use in basic auth
+
+```
+$ dalmatian util generate-four-words
+Please note that the phrases generated here should not be used as login
+passwords or to hide secrets. Please use 1Password in those cicumstances.
+If you have any questions, please ask the Technical Operations team for advice.
+
+width-males-minded-random
+```
+
+To suppress the warning, add `-q` to the command
+
+```
+$ dalmatian util generate-four-words -q
+away-naught-wagner-mimic
+```
+
 #### `dalmatian util exec`
 
 This command allows an operator to execute a cli command in an infrastructure. It can be useful for bootstrapping new accounts, getting AWS env vars, or running generic scripts against a remote infrastructure.
@@ -273,3 +273,15 @@ $ dalmatian util exec -i "$infrastructure" aws account list-regions | less
     },
     [..]
 ```
+
+### `dalmatian config`
+
+This collection of tools are useful for collating facts from the compiled `dalmatian-config.yml`.
+
+>[!NOTE]
+>Each one of these scripts will first attempt to refresh your `dalmatian-config.yml` file if it is considered outdated.
+
+#### `dalmatian config list-services-by-buildspec`
+#### `dalmatian config list-services`
+#### `dalmatian config list-environments`
+#### `dalmatian config list-infrastructures`