From f62dcc816b501e8a83cb36bc2a5e2fdfcbc62d88 Mon Sep 17 00:00:00 2001 From: George Vauter Date: Tue, 17 Sep 2024 18:13:56 -0400 Subject: [PATCH] docs: refactor wording for clarity --- docs/architecture/decisions/implement-cli-framework_001.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/architecture/decisions/implement-cli-framework_001.md b/docs/architecture/decisions/implement-cli-framework_001.md index 894c7576..30bf1ca4 100644 --- a/docs/architecture/decisions/implement-cli-framework_001.md +++ b/docs/architecture/decisions/implement-cli-framework_001.md @@ -20,7 +20,7 @@ The trestlebot module will be refactored to remove the use of `argparse` in favo In addition, support will be added for using a configuration file and environment variables as CLI inputs. The CLI will prioritize arguments passed as command flags. If no argument is passed, the CLI will check for an environment variable. Finally, if no enviroment variable is found, it will look to the configuration file. -The configuration file will be broken into two primary categories, `global` and `model specific`. Global configuration will apply across all models and include values such as git provider, markdown directories, etc. Model specific configuration will apply to the given OSCAL model only. While it is expected that most repos will be used for authoring a single OSCAL model, the possiblity of authoring more than one model would be supported. The configuration file would be initialized during the `trestlebot init` command. Manually creation and editing is also possible. The user could also specify a configuration file using the `--config | -c` flag. This would not be required if using the default configuration file location. +The configuration file will be broken into two primary categories, `global` and `model specific`. Global configuration will apply across all models and include values such as git provider, markdown directories, etc. Model specific configuration will apply to the given OSCAL model only. While it is expected that most repos will be used for authoring a single OSCAL model, the possiblity of authoring more than one model would be supported. The configuration file would be initialized at a default location during the `trestlebot init` command. Manual creation and editing is also possible. The path to the configuration file can be passed using the `--config | -c` flag. This would not be required if using the default file location. - the default configuration file location will be `.trestlebot/config.yaml` - all environment variables will have a `TRESTLEBOT_` prefix