Merge pull request #35 from surdaft/compatibility-info

Address #33 comments
satisfactorymodding · Aug 16, 2023 · 06b2cf6 · 06b2cf6
2 parents bd6e243 + 80626df
commit 06b2cf6
Show file tree

Hide file tree

Showing 22 changed files with 169 additions and 107 deletions.
diff --git a/README.md b/README.md
@@ -106,3 +106,12 @@ Then, to run it, use:
 ```bash
 golangci-lint run --fix
 ```
+
+### Updating generated docs
+
+The files within `./docs` are generated using cobra, use the following to update
+them.
+
+```
+go run tools.go
+```
diff --git a/cmd/root.go b/cmd/root.go
@@ -123,7 +123,7 @@ func init() {
 	}
 
 	RootCmd.PersistentFlags().String("log", "info", "The log level to output")
-	RootCmd.PersistentFlags().String("log-file", "ficsit-cli.log", "File to output logs to")
+	RootCmd.PersistentFlags().String("log-file", "", "File to output logs to")
 	RootCmd.PersistentFlags().Bool("quiet", false, "Do not log anything to console")
 	RootCmd.PersistentFlags().Bool("pretty", true, "Whether to render pretty terminal output")
 

diff --git a/docs/ficsit.md b/docs/ficsit.md
@@ -7,14 +7,14 @@ cli mod manager for satisfactory
 ```
       --api-base string             URL for API (default "https://api.ficsit.app")
       --api-key string              API key to use when sending requests
-      --cache-dir string            The cache directory (default "/home/vilsol/.cache/ficsit")
+      --cache-dir string            The cache directory (default "/home/{{Username}}/.cache/ficsit")
       --dry-run                     Dry-run. Do not save any changes
       --graphql-api string          Path for GraphQL API (default "/v2/query")
   -h, --help                        help for ficsit
       --installations-file string   The installations file (default "installations.json")
-      --local-dir string            The local directory (default "/home/vilsol/.local/share/ficsit")
+      --local-dir string            The local directory (default "/home/{{Username}}/.local/share/ficsit")
       --log string                  The log level to output (default "info")
-      --log-file string             File to output logs to (default "ficsit-cli.log")
+      --log-file string             File to output logs to
       --pretty                      Whether to render pretty terminal output (default true)
       --profiles-file string        The profiles file (default "profiles.json")
       --quiet                       Do not log anything to console
@@ -30,4 +30,4 @@ cli mod manager for satisfactory
 * [ficsit smr](ficsit_smr.md)	 - Manage mods on SMR
 * [ficsit version](ficsit_version.md)	 - Print current version information
 
-###### Auto generated by spf13/cobra on 10-Jul-2023
+###### Auto generated by spf13/cobra on 16-Aug-2023
diff --git a/docs/ficsit_apply.md b/docs/ficsit_apply.md
@@ -17,13 +17,13 @@ ficsit apply [installation] ... [flags]
 ```
       --api-base string             URL for API (default "https://api.ficsit.app")
       --api-key string              API key to use when sending requests
-      --cache-dir string            The cache directory (default "/home/vilsol/.cache/ficsit")
+      --cache-dir string            The cache directory (default "/home/{{Username}}/.cache/ficsit")
       --dry-run                     Dry-run. Do not save any changes
       --graphql-api string          Path for GraphQL API (default "/v2/query")
       --installations-file string   The installations file (default "installations.json")
-      --local-dir string            The local directory (default "/home/vilsol/.local/share/ficsit")
+      --local-dir string            The local directory (default "/home/{{Username}}/.local/share/ficsit")
       --log string                  The log level to output (default "info")
-      --log-file string             File to output logs to (default "ficsit-cli.log")
+      --log-file string             File to output logs to
       --pretty                      Whether to render pretty terminal output (default true)
       --profiles-file string        The profiles file (default "profiles.json")
       --quiet                       Do not log anything to console
@@ -33,4 +33,4 @@ ficsit apply [installation] ... [flags]
 
 * [ficsit](ficsit.md)	 - cli mod manager for satisfactory
 
-###### Auto generated by spf13/cobra on 10-Jul-2023
+###### Auto generated by spf13/cobra on 16-Aug-2023
diff --git a/docs/ficsit_cli.md b/docs/ficsit_cli.md
@@ -17,13 +17,13 @@ ficsit cli [flags]
 ```
       --api-base string             URL for API (default "https://api.ficsit.app")
       --api-key string              API key to use when sending requests
-      --cache-dir string            The cache directory (default "/home/vilsol/.cache/ficsit")
+      --cache-dir string            The cache directory (default "/home/{{Username}}/.cache/ficsit")
       --dry-run                     Dry-run. Do not save any changes
       --graphql-api string          Path for GraphQL API (default "/v2/query")
       --installations-file string   The installations file (default "installations.json")
-      --local-dir string            The local directory (default "/home/vilsol/.local/share/ficsit")
+      --local-dir string            The local directory (default "/home/{{Username}}/.local/share/ficsit")
       --log string                  The log level to output (default "info")
-      --log-file string             File to output logs to (default "ficsit-cli.log")
+      --log-file string             File to output logs to
       --pretty                      Whether to render pretty terminal output (default true)
       --profiles-file string        The profiles file (default "profiles.json")
       --quiet                       Do not log anything to console
@@ -33,4 +33,4 @@ ficsit cli [flags]
 
 * [ficsit](ficsit.md)	 - cli mod manager for satisfactory
 
-###### Auto generated by spf13/cobra on 10-Jul-2023
+###### Auto generated by spf13/cobra on 16-Aug-2023
diff --git a/docs/ficsit_installation.md b/docs/ficsit_installation.md
@@ -13,13 +13,13 @@ Manage installations
 ```
       --api-base string             URL for API (default "https://api.ficsit.app")
       --api-key string              API key to use when sending requests
-      --cache-dir string            The cache directory (default "/home/vilsol/.cache/ficsit")
+      --cache-dir string            The cache directory (default "/home/{{Username}}/.cache/ficsit")
       --dry-run                     Dry-run. Do not save any changes
       --graphql-api string          Path for GraphQL API (default "/v2/query")
       --installations-file string   The installations file (default "installations.json")
-      --local-dir string            The local directory (default "/home/vilsol/.local/share/ficsit")
+      --local-dir string            The local directory (default "/home/{{Username}}/.local/share/ficsit")
       --log string                  The log level to output (default "info")
-      --log-file string             File to output logs to (default "ficsit-cli.log")
+      --log-file string             File to output logs to
       --pretty                      Whether to render pretty terminal output (default true)
       --profiles-file string        The profiles file (default "profiles.json")
       --quiet                       Do not log anything to console
@@ -33,4 +33,4 @@ Manage installations
 * [ficsit installation remove](ficsit_installation_remove.md)	 - Remove an installation
 * [ficsit installation set-profile](ficsit_installation_set-profile.md)	 - Change the profile of an installation
 
-###### Auto generated by spf13/cobra on 10-Jul-2023
+###### Auto generated by spf13/cobra on 16-Aug-2023
diff --git a/docs/ficsit_installation_add.md b/docs/ficsit_installation_add.md
@@ -17,13 +17,13 @@ ficsit installation add <path> [profile] [flags]
 ```
       --api-base string             URL for API (default "https://api.ficsit.app")
       --api-key string              API key to use when sending requests
-      --cache-dir string            The cache directory (default "/home/vilsol/.cache/ficsit")
+      --cache-dir string            The cache directory (default "/home/{{Username}}/.cache/ficsit")
       --dry-run                     Dry-run. Do not save any changes
       --graphql-api string          Path for GraphQL API (default "/v2/query")
       --installations-file string   The installations file (default "installations.json")
-      --local-dir string            The local directory (default "/home/vilsol/.local/share/ficsit")
+      --local-dir string            The local directory (default "/home/{{Username}}/.local/share/ficsit")
       --log string                  The log level to output (default "info")
-      --log-file string             File to output logs to (default "ficsit-cli.log")
+      --log-file string             File to output logs to
       --pretty                      Whether to render pretty terminal output (default true)
       --profiles-file string        The profiles file (default "profiles.json")
       --quiet                       Do not log anything to console
@@ -33,4 +33,4 @@ ficsit installation add <path> [profile] [flags]
 
 * [ficsit installation](ficsit_installation.md)	 - Manage installations
 
-###### Auto generated by spf13/cobra on 10-Jul-2023
+###### Auto generated by spf13/cobra on 16-Aug-2023
diff --git a/docs/ficsit_installation_ls.md b/docs/ficsit_installation_ls.md
@@ -17,13 +17,13 @@ ficsit installation ls [flags]
 ```
       --api-base string             URL for API (default "https://api.ficsit.app")
       --api-key string              API key to use when sending requests
-      --cache-dir string            The cache directory (default "/home/vilsol/.cache/ficsit")
+      --cache-dir string            The cache directory (default "/home/{{Username}}/.cache/ficsit")
       --dry-run                     Dry-run. Do not save any changes
       --graphql-api string          Path for GraphQL API (default "/v2/query")
       --installations-file string   The installations file (default "installations.json")
-      --local-dir string            The local directory (default "/home/vilsol/.local/share/ficsit")
+      --local-dir string            The local directory (default "/home/{{Username}}/.local/share/ficsit")
       --log string                  The log level to output (default "info")
-      --log-file string             File to output logs to (default "ficsit-cli.log")
+      --log-file string             File to output logs to
       --pretty                      Whether to render pretty terminal output (default true)
       --profiles-file string        The profiles file (default "profiles.json")
       --quiet                       Do not log anything to console
@@ -33,4 +33,4 @@ ficsit installation ls [flags]
 
 * [ficsit installation](ficsit_installation.md)	 - Manage installations
 
-###### Auto generated by spf13/cobra on 10-Jul-2023
+###### Auto generated by spf13/cobra on 16-Aug-2023
diff --git a/docs/ficsit_installation_remove.md b/docs/ficsit_installation_remove.md
@@ -17,13 +17,13 @@ ficsit installation remove <path> [flags]
 ```
       --api-base string             URL for API (default "https://api.ficsit.app")
       --api-key string              API key to use when sending requests
-      --cache-dir string            The cache directory (default "/home/vilsol/.cache/ficsit")
+      --cache-dir string            The cache directory (default "/home/{{Username}}/.cache/ficsit")
       --dry-run                     Dry-run. Do not save any changes
       --graphql-api string          Path for GraphQL API (default "/v2/query")
       --installations-file string   The installations file (default "installations.json")
-      --local-dir string            The local directory (default "/home/vilsol/.local/share/ficsit")
+      --local-dir string            The local directory (default "/home/{{Username}}/.local/share/ficsit")
       --log string                  The log level to output (default "info")
-      --log-file string             File to output logs to (default "ficsit-cli.log")
+      --log-file string             File to output logs to
       --pretty                      Whether to render pretty terminal output (default true)
       --profiles-file string        The profiles file (default "profiles.json")
       --quiet                       Do not log anything to console
@@ -33,4 +33,4 @@ ficsit installation remove <path> [flags]
 
 * [ficsit installation](ficsit_installation.md)	 - Manage installations
 
-###### Auto generated by spf13/cobra on 10-Jul-2023
+###### Auto generated by spf13/cobra on 16-Aug-2023
diff --git a/docs/ficsit_installation_set-profile.md b/docs/ficsit_installation_set-profile.md
@@ -17,13 +17,13 @@ ficsit installation set-profile <path> <profile> [flags]
 ```
       --api-base string             URL for API (default "https://api.ficsit.app")
       --api-key string              API key to use when sending requests
-      --cache-dir string            The cache directory (default "/home/vilsol/.cache/ficsit")
+      --cache-dir string            The cache directory (default "/home/{{Username}}/.cache/ficsit")
       --dry-run                     Dry-run. Do not save any changes
       --graphql-api string          Path for GraphQL API (default "/v2/query")
       --installations-file string   The installations file (default "installations.json")
-      --local-dir string            The local directory (default "/home/vilsol/.local/share/ficsit")
+      --local-dir string            The local directory (default "/home/{{Username}}/.local/share/ficsit")
       --log string                  The log level to output (default "info")
-      --log-file string             File to output logs to (default "ficsit-cli.log")
+      --log-file string             File to output logs to
       --pretty                      Whether to render pretty terminal output (default true)
       --profiles-file string        The profiles file (default "profiles.json")
       --quiet                       Do not log anything to console
@@ -33,4 +33,4 @@ ficsit installation set-profile <path> <profile> [flags]
 
 * [ficsit installation](ficsit_installation.md)	 - Manage installations
 
-###### Auto generated by spf13/cobra on 10-Jul-2023
+###### Auto generated by spf13/cobra on 16-Aug-2023
diff --git a/docs/ficsit_profile.md b/docs/ficsit_profile.md
@@ -13,13 +13,13 @@ Manage profiles
 ```
       --api-base string             URL for API (default "https://api.ficsit.app")
       --api-key string              API key to use when sending requests
-      --cache-dir string            The cache directory (default "/home/vilsol/.cache/ficsit")
+      --cache-dir string            The cache directory (default "/home/{{Username}}/.cache/ficsit")
       --dry-run                     Dry-run. Do not save any changes
       --graphql-api string          Path for GraphQL API (default "/v2/query")
       --installations-file string   The installations file (default "installations.json")
-      --local-dir string            The local directory (default "/home/vilsol/.local/share/ficsit")
+      --local-dir string            The local directory (default "/home/{{Username}}/.local/share/ficsit")
       --log string                  The log level to output (default "info")
-      --log-file string             File to output logs to (default "ficsit-cli.log")
+      --log-file string             File to output logs to
       --pretty                      Whether to render pretty terminal output (default true)
       --profiles-file string        The profiles file (default "profiles.json")
       --quiet                       Do not log anything to console
@@ -34,4 +34,4 @@ Manage profiles
 * [ficsit profile new](ficsit_profile_new.md)	 - Create a new profile
 * [ficsit profile rename](ficsit_profile_rename.md)	 - Rename a profile
 
-###### Auto generated by spf13/cobra on 10-Jul-2023
+###### Auto generated by spf13/cobra on 16-Aug-2023
diff --git a/docs/ficsit_profile_delete.md b/docs/ficsit_profile_delete.md
@@ -17,13 +17,13 @@ ficsit profile delete <name> [flags]
 ```
       --api-base string             URL for API (default "https://api.ficsit.app")
       --api-key string              API key to use when sending requests
-      --cache-dir string            The cache directory (default "/home/vilsol/.cache/ficsit")
+      --cache-dir string            The cache directory (default "/home/{{Username}}/.cache/ficsit")
       --dry-run                     Dry-run. Do not save any changes
       --graphql-api string          Path for GraphQL API (default "/v2/query")
       --installations-file string   The installations file (default "installations.json")
-      --local-dir string            The local directory (default "/home/vilsol/.local/share/ficsit")
+      --local-dir string            The local directory (default "/home/{{Username}}/.local/share/ficsit")
       --log string                  The log level to output (default "info")
-      --log-file string             File to output logs to (default "ficsit-cli.log")
+      --log-file string             File to output logs to
       --pretty                      Whether to render pretty terminal output (default true)
       --profiles-file string        The profiles file (default "profiles.json")
       --quiet                       Do not log anything to console
@@ -33,4 +33,4 @@ ficsit profile delete <name> [flags]
 
 * [ficsit profile](ficsit_profile.md)	 - Manage profiles
 
-###### Auto generated by spf13/cobra on 10-Jul-2023
+###### Auto generated by spf13/cobra on 16-Aug-2023
diff --git a/docs/ficsit_profile_ls.md b/docs/ficsit_profile_ls.md
@@ -17,13 +17,13 @@ ficsit profile ls [flags]
 ```
       --api-base string             URL for API (default "https://api.ficsit.app")
       --api-key string              API key to use when sending requests
-      --cache-dir string            The cache directory (default "/home/vilsol/.cache/ficsit")
+      --cache-dir string            The cache directory (default "/home/{{Username}}/.cache/ficsit")
       --dry-run                     Dry-run. Do not save any changes
       --graphql-api string          Path for GraphQL API (default "/v2/query")
       --installations-file string   The installations file (default "installations.json")
-      --local-dir string            The local directory (default "/home/vilsol/.local/share/ficsit")
+      --local-dir string            The local directory (default "/home/{{Username}}/.local/share/ficsit")
       --log string                  The log level to output (default "info")
-      --log-file string             File to output logs to (default "ficsit-cli.log")
+      --log-file string             File to output logs to
       --pretty                      Whether to render pretty terminal output (default true)
       --profiles-file string        The profiles file (default "profiles.json")
       --quiet                       Do not log anything to console
@@ -33,4 +33,4 @@ ficsit profile ls [flags]
 
 * [ficsit profile](ficsit_profile.md)	 - Manage profiles
 
-###### Auto generated by spf13/cobra on 10-Jul-2023
+###### Auto generated by spf13/cobra on 16-Aug-2023
diff --git a/docs/ficsit_profile_mods.md b/docs/ficsit_profile_mods.md
@@ -17,13 +17,13 @@ ficsit profile mods <profile> [flags]
 ```
       --api-base string             URL for API (default "https://api.ficsit.app")
       --api-key string              API key to use when sending requests
-      --cache-dir string            The cache directory (default "/home/vilsol/.cache/ficsit")
+      --cache-dir string            The cache directory (default "/home/{{Username}}/.cache/ficsit")
       --dry-run                     Dry-run. Do not save any changes
       --graphql-api string          Path for GraphQL API (default "/v2/query")
       --installations-file string   The installations file (default "installations.json")
-      --local-dir string            The local directory (default "/home/vilsol/.local/share/ficsit")
+      --local-dir string            The local directory (default "/home/{{Username}}/.local/share/ficsit")
       --log string                  The log level to output (default "info")
-      --log-file string             File to output logs to (default "ficsit-cli.log")
+      --log-file string             File to output logs to
       --pretty                      Whether to render pretty terminal output (default true)
       --profiles-file string        The profiles file (default "profiles.json")
       --quiet                       Do not log anything to console
@@ -33,4 +33,4 @@ ficsit profile mods <profile> [flags]
 
 * [ficsit profile](ficsit_profile.md)	 - Manage profiles
 
-###### Auto generated by spf13/cobra on 10-Jul-2023
+###### Auto generated by spf13/cobra on 16-Aug-2023