Usage - DependenSee <SourceFolder> [<OutputPath>] -options
For full docs in the command line, run without any arguments.
To see the version installed, use dotnet tool list instead. (if you installed globally, -g option is required.)
DependenSee will exit with 0 if there were no errors (may have warnings) and with 1 if the command failed.
See stderr stream for warnings. If you're running in a standard command line, these will be included in the output, but will not be included if you're redirecting/piping the stdout to a file or another program.
Shows help descriptions. Help is also displayed if no arguments were provided.
Shorthand: -H
DependenSee -HelpDependenSee -HDependenSee
Root folder (usually solution folder) to look for csproj files recursively. If no explicit options are specified, the first argument is assumed to be this option.
If your path has spaces, you will need to enclose it in double quotes.
Note that if a project inside this folder has a reference to a project that is outside of this folder, DependenSee WILL enumerate those folders. However this is not reccomended. Always run DependenSee on the root folder of your projects for consistent and correct results.
DependenSee \Source\MySolutionFolderDependenSee -SourceFolder \Source\MySolutionFolderDependenSee -S \Source\MySolutionFolder
Path to write the result. Not required if writing the output to stdout. If no explicit options are specified, the second argument is assumed to be this option.
If your path has spaces, you will need to enclose it in double quotes.
Shorthand: -O
DependenSee \Source\SolutionFolder \Test\MyOutput.htmlDependenSee \Source\SolutionFolder -O \Test\MyOutput.htmlDependenSee \Source\SolutionFolder -OutputPath \Test\MyOutput.html
Whether to include external (Nuget) packages in the result.
Shorthand: -P
Default: False
DependenSee \Source\SolutionFolder \Test\MyOutput.html -PDependenSee \Source\SolutionFolder \Test\MyOutput.html -IncludePackages
Type of output to produce. Following types are available.
Html- Creates an html document.Json- Creates a JSON file.Xml- Creates a XML file.Graphviz- Creates a Graphviz/DOT file.ConsoleJson- Writes JSON output to stdoutConsoleXml- Writes XML output to stdoutGonsoleGraphviz- Writes Graphviz output to stdout
When a Console... type output is specified, the -OutputPath can be ommitted.
Console... output types may still write warings to stderr stream. If you're piping just the stderr into another program, consider checking the stderr for warnings as well.
if you'd like to hide stderr output from your console output, see Troubleshooting section below.
To visualize Graphviz output, either use
-
Use an online visualizer such as https://dreampuf.github.io/GraphvizOnline
-
or use tooling from https://graphviz.org
- once installed you can use
.\dot.exe DependenSee-OutputFile.dot -oTargetFile.Svg -Tsvg dot.exeis located atyour-graphvis-installation/bin- see Graphviz docs for command line usage and supported output types
- once installed you can use
Shorthand: -T
Default: Html
DependenSee \Source\SolutionFolder \Test\MyOutput.html -T XmlDependenSee \Source\SolutionFolder \Test\MyOutput.html -OutputType JsonDependenSee \Source\SolutionFolder -T ConsoleJson
Document title for Html output. Ignored when creating output types other than Html.
If your title has spaces, you will need to enclose it in double quotes. The title should not be HTML-encoded ahead of time as DependenSee will do this automatically.
Shorthand: -HT
Default: DependenSee
DependenSee \Source\SolutionFolder \Test\MyOutput.html -HtmlTitle "My Graph Title"DependenSee \Source\SolutionFolder \Test\MyOutput.html -T Html -HtmlTitle my-graph-titleDependenSee \Source\SolutionFolder \Test\MyOutput.html -HT "My Graph Title"
Comma separated list of project file prefixes to include. Wildcards not allowed. Only the filename is considered, case insensitive.
If you want to include spaces between items, make sure you enclose the parameter value in double quotes.
Shorthand: -IPrN
Default: <empty string>
DependenSee \Source\SolutionFolder -O ConsoleJson -IncludeProjectNamespaces MyApp.Extensions,MyApp.Core- Includes only projects starting with MyApp.Core and projects starting with MyApp.Extensions
DependenSee \Source\SolutionFolder -O ConsoleJson -IPrN MyApp.Extensions,MyApp.Core- Includes only projects starting with MyApp.Core and projects starting with MyApp.Extensions
Comma separated list of project file prefixes to exclude. Wildcards not allowed. Only the filename is considered, case insensitive. This must be a subset of includes to be useful.
If you want to include spaces between items, make sure you enclose the parameter value in double quotes.
Shorthand: -EPrN
Default: <unspecified>
DependenSee \Source\SolutionFolder -O ConsoleJson -ExcludeProjectNamespaces MyApp.Extensions, MyApp.Helpers- Excludes projects starting with MyApp.Extensions and projects starting with MyApp.Helpers
DependenSee \Source\SolutionFolder -O ConsoleJson -EPrN MyApp.Extensions, MyApp.Helpers- Excludes projects starting with MyApp.Extensions and projects starting with MyApp.Helpers
Comma separated list of package name prefixes to include. Wildcards not allowed. Only the package name is considered, case insensitive. If specified, -IncludePackages is overridden to True.
If you want to include spaces between items, make sure you enclose the parameter value in double quotes.
Shorthand: -IPaN
Default: <empty string>
DependenSee \Source\SolutionFolder -O ConsoleJson -IncludePackageNamespaces Xamarin,Microsoft- includes only packages starting with Xamarin and packages starting with Microsoft
DependenSee \Source\SolutionFolder -O ConsoleJson -IPaN Xamarin,Microsoft- includes only packages starting with Xamarin and packages starting with Microsoft
Comma separated list of package name prefixes to exclude. Wildcards not allowed. Only the filename is considered, case insensitive. If specified, -IncludePackages is overridden to True. This must be a subset of includes to be useful.
If you want to include spaces between items, make sure you enclose the parameter value in double quotes.
Shorthand: -EPaN
Default: <unspecified>
Set if you want the scan to follow valid reparse points. This is helpful if your project references are relying on symlinks, NTFS junction points .etc.
If set to True and a junction/reparse point points to a folder that does not exist (DirectoryInfo.Exists == false) it is still skipped (with a message to stderr).
If set to False and a reparse point is encountered, a message is also emitted with the full path showing which reparse point is skipped.
Shorthand: -FReP
Default: False
DependenSee \Source\SolutionFolder -FollowReparsePointsDependenSee \Source\SolutionFolder -FReP
Comma Separated list of folders (either absolute paths or relative to SourceFolder) to skip during scan, even if there are references to them from your projects. Wildcards not allowed. When a folder is matched and skipped by a rule specified this way, will emit a warning into the stderr stream. Paths here are case insensitive.
While you can specify to exclude a path outside of the source folder, and it will be considered if a project has a reference to a project outside of the source folder, this is not recommended. Always run DependenSee against the root folder of your projects to get consitent and correct results.
Shorthand: -EFol
Default: <unspecified>
DependenSee \Source\SolutionFolder -ExcludeFolders "\Source\SolutionFolder\docs, Source\SolutionFolder\clientapp\node-modules"DependenSee \Source\SolutionFolder -EFol "C:\Source\SolutionFolder\docs, \Source\SolutionFolder\clientapp\node-modules"