Skip to content

doc: update CLI/tool documentation for /diag argument #4764

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 27, 2025
Merged

doc: update CLI/tool documentation for /diag argument #4764

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fe059ca
doc: /diag now requires a /l argument to select output stream
davidjenni Nov 26, 2025
dc77d63
test: adding test for /diag argument in help text
davidjenni Nov 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions docs/input/docs/usage/cli/arguments.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@ GitVersion [path]
path The directory containing .git. If not defined current
directory is used. (Must be first argument)
/version Displays the version of GitVersion
/diag Runs GitVersion with additional diagnostic information
/diag Runs GitVersion with additional diagnostic information;
also needs the '/l' argument to specify a logfile or stdout
(requires git.exe to be installed)
/h or /? Shows Help

Expand All @@ -41,7 +42,7 @@ GitVersion [path]
Supports C# format strings - see [Format Strings](/docs/reference/custom-formatting) for details.
E.g. /output json /format {SemVer} - will output `1.2.3+beta.4`
/output json /format {Major}.{Minor} - will output `1.2`
/l Path to logfile.
/l Path to logfile; specify 'console' to emit to stdout.
/config Path to config file (defaults to GitVersion.yml, GitVersion.yaml, .GitVersion.yml or .GitVersion.yaml)
/showconfig Outputs the effective GitVersion config (defaults + custom
from GitVersion.yml, GitVersion.yaml, .GitVersion.yml or .GitVersion.yaml) in yaml format
Expand Down
1 change: 1 addition & 0 deletions src/GitVersion.App.Tests/HelpWriterTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ public void AllArgsAreInHelp()
{ nameof(Arguments.ClonePath), "/dynamicRepoLocation" },
{ nameof(Arguments.CommitId), "/c" },

{ nameof(Arguments.Diag) , "/diag" },
{ nameof(Arguments.LogFilePath) , "/l" },
{ nameof(Arguments.Verbosity), "/verbosity" },
{ nameof(Arguments.Output) , "/output" },
Expand Down