Skip to content

Commit c910de3

Browse files
committed
Added some cli options
1 parent 0f1db48 commit c910de3

File tree

2 files changed

+9
-3
lines changed

2 files changed

+9
-3
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,16 @@ There are 2 ways to run this. As a .NET Tool installed on your machine, or downl
3232
- --config-file, -d
3333
- Required
3434
- Path to the file to use for config values when updating code
35+
- --output-file, -o
36+
- Optional
37+
- If this is set, it will be the file to write logs to, in addition to the console
38+
- --log-level, -l
39+
- Optional
40+
- Verbosity level to log. Valid values are: Verbose, Info, Warn, Error. Default value: verbose.
3541

3642
## Config File
3743

38-
The config file holds all values to determine what changes to make to code files. The reason this is separate from CLI input arguments is to let a developer store this config in different repos but have this .NET Tool installed globally on their machine. That makes it easy to let other developers run this tool with specific settings for each repository, while only needing to provide a single CLI input argument.
44+
The config file holds all values to determine what changes to make. The reason this is separate from CLI input arguments is to let a developer store this config in different repos but have this .NET Tool installed globally on their machine. That makes it easy to let other developers run this tool with specific settings for each repository, while only needing to provide a single CLI input argument.
3945

4046
Below are the list of properties in the config file. All fields are required.
4147

src/CodeUpdater/CodeUpdater/Options/CommandOptions.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ public class CommandOptions
1414
[Option(shortName: 'c', longName: "config-file", Required = true, HelpText = "Path to the file to use for config values when updating code")]
1515
public required string ConfigFile { get; set; }
1616

17-
[Option(shortName: 'o', longName: "output-file", Required = false, HelpText = "If this is set, it will be the file to write logs to.")]
17+
[Option(shortName: 'o', longName: "output-file", Required = false, HelpText = "If this is set, it will be the file to write logs to, in addition to the console")]
1818
public string? OutputFile { get; set; }
1919

20-
[Option(shortName: 'l', longName: "log-level", Required = false, HelpText = "Level to log. Valid values are: Verbose, Info, Warn, Error. Default value is verbose.")]
20+
[Option(shortName: 'l', longName: "log-level", Required = false, HelpText = "Verbosity level to log. Valid values are: Verbose, Info, Warn, Error. Default value: verbose.")]
2121
public string LogLevel { get; set; } = "verbose";
2222
}

0 commit comments

Comments
 (0)