https://github.com/nikiforovall/dependify
Explore project dependencies in .NET
https://github.com/nikiforovall/dependify
aspire cli dependency-management msbuild tool
Last synced: about 1 year ago
JSON representation
Explore project dependencies in .NET
- Host: GitHub
- URL: https://github.com/nikiforovall/dependify
- Owner: NikiforovAll
- License: mit
- Created: 2024-07-18T19:58:13.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-13T10:42:52.000Z (over 1 year ago)
- Last Synced: 2025-02-27T05:56:10.266Z (about 1 year ago)
- Topics: aspire, cli, dependency-management, msbuild, tool
- Language: C#
- Homepage: https://nikiforovall.github.io/dotnet/2024/08/03/dependify.html
- Size: 19.5 MB
- Stars: 66
- Watchers: 2
- Forks: 4
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Dependify
[](https://github.com/NikiforovAll/dependify/actions/workflows/build.yml)
[](https://nuget.org/packages/Dependify.Cli)
[](https://github.com/nikiforovall/dependify)
[](https://conventionalcommits.org)
[](https://github.com/nikiforovall/dependify/blob/main/LICENSE.md)
Dependify is a tool to visualize dependencies in your .NET application. You can start dependify in `serve` mode to visualize dependencies in a browser or use the `CLI` if you prefer the terminal.
| Package | Version | Description |
| --------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -------------- |
| `Dependify.Cli` | [](https://nuget.org/packages/Dependify.Cli) | CLI |
| `Dependify.Core` | [](https://nuget.org/packages/Dependify.Core) | Core library |
| `Dependify.Aspire.Hosting` | [](https://nuget.org/packages/Dependify.Aspire.Hosting) | Aspire support |
Blogs:
* [Explore .NET application dependencies by using Dependify tool](https://nikiforovall.github.io/dotnet/2024/08/03/dependify.html)
* [Supercharge your Dependify tool with AI chat assistant](https://nikiforovall.github.io/dotnet/2024/08/09/dependify-ai.html)
## Install
```bash
dotnet tool install -g Dependify.Cli
```
## Usage
```bash
dependify serve $dev/path-to-folder/
```
You will see something like the following output in the terminal.
### Features
- Workbench ⚙️
- Dependency Explorer 🔎
- Chat (AI) 🤖
Workbench gives you high level overview of the dependencies in the solution.
You can open the mermaid diagram right in the browser.
Dependency Explorer allows you to select the dependencies you want to see.
Chat (AI) allows you to ask questions about the dependencies.
Here is how to run the Dependify with the OpenAI GPT-4 model.
```bash
dependify serve $dev/cap-aspire/ \
--endpoint https://api.openai.azure.com/ \
--deployment-name gpt-4o-mini \
--api-key
```
### Aspire support
You can add `Dependify.Web` as resource to your Aspire project.
Add the package to AppHost:
```bash
dotnet add package Dependify.Aspire.Hosting
```
Register via `IDistributedApplicationBuilder`. Add the following code to your `Program.cs`:
```csharp
var builder = DistributedApplication.CreateBuilder(args);
var apiService = builder.AddProject("apiservice");
builder.AddProject("webfrontend")
.WithExternalHttpEndpoints()
.WithReference(apiService);
builder.AddDependify().ServeFrom("../../aspire-project/"); // <-- location of .sln file
builder.Build().Run();
```
See the [samples/aspire-project](./samples/aspire-project) for more details.
### CLI
You can use the CLI for the automation or if you prefer the terminal.
```bash
dependify graph --help
```
```text
USAGE:
dependify graph [OPTIONS]
EXAMPLES:
dependify graph scan ./path/to/folder --framework net8
dependify graph show ./path/to/project --framework net8
OPTIONS:
-h, --help Prints help information
COMMANDS:
scan Scans for projects and solutions and retrives their dependencies
show Shows the dependencies of a project or solution located in the specified path
```
The command `scan` will scan the folder for projects and solutions and retrieve their dependencies. The ouput can be in `tui` or `mermaid` format. The `tui` or terminal user interface is the default output format.
```bash
dependify graph scan $dev/keycloak-authorization-services-dotnet/
```
Here is how to change the output format to `mermaid`.
```bash
dependify graph scan \
$dev/keycloak-authorization-services-dotnet/ \
--exclude-sln \
--format mermaid \
--output ./graph.md
```
```mermaid
graph LR
Keycloak.AuthServices.Authentication.csproj:::project
Keycloak.AuthServices.Templates.csproj:::project
Blazor.Server.csproj:::project
GettingStarted.csproj:::project
AuthorizationGettingStarted.csproj:::project
AuthorizationAndCleanArchitecture.csproj:::project
Blazor.Client.csproj:::project
TestWebApi.csproj:::project
Keycloak.AuthServices.Authorization.csproj:::project
Keycloak.AuthServices.Common.csproj:::project
TestWebApiWithControllers.csproj:::project
Keycloak.AuthServices.Sdk.csproj:::project
WebApp.csproj:::project
Keycloak.AuthServices.Sdk.Tests.csproj:::project
AuthGettingStarted.csproj:::project
Keycloak.AuthServices.Common.Tests.csproj:::project
Keycloak.AuthServices.Authentication.Tests.csproj:::project
Keycloak.AuthServices.Aspire.Hosting.csproj:::project
ResourceAuthorization.csproj:::project
Keycloak.AuthServices.OpenTelemetry.csproj:::project
Keycloak.AuthServices.Authorization.Tests.csproj:::project
Keycloak.AuthServices.IntegrationTests.csproj:::project
Keycloak.AuthServices.Sdk.Kiota.csproj:::project
Blazor.Shared.csproj:::project
Keycloak.AuthServices.IntegrationTests.csproj --> Keycloak.AuthServices.Sdk.csproj
Keycloak.AuthServices.Common.Tests.csproj --> Keycloak.AuthServices.Common.csproj
AuthGettingStarted.csproj --> Keycloak.AuthServices.Authorization.csproj
ResourceAuthorization.csproj --> Keycloak.AuthServices.OpenTelemetry.csproj
Keycloak.AuthServices.Authorization.Tests.csproj --> Keycloak.AuthServices.Authentication.csproj
AuthGettingStarted.csproj --> Keycloak.AuthServices.Sdk.csproj
Keycloak.AuthServices.Authorization.csproj --> Keycloak.AuthServices.Common.csproj
WebApp.csproj --> Keycloak.AuthServices.Authorization.csproj
GettingStarted.csproj --> Keycloak.AuthServices.Authentication.csproj
ResourceAuthorization.csproj --> Keycloak.AuthServices.Sdk.Kiota.csproj
WebApp.csproj --> Keycloak.AuthServices.Common.csproj
Keycloak.AuthServices.Sdk.Kiota.csproj --> Keycloak.AuthServices.Common.csproj
AuthorizationGettingStarted.csproj --> Keycloak.AuthServices.Authentication.csproj
Keycloak.AuthServices.Authorization.Tests.csproj --> Keycloak.AuthServices.Authorization.csproj
ResourceAuthorization.csproj --> Keycloak.AuthServices.Authentication.csproj
Keycloak.AuthServices.Authorization.Tests.csproj --> Keycloak.AuthServices.Common.csproj
Keycloak.AuthServices.IntegrationTests.csproj --> Keycloak.AuthServices.Sdk.Kiota.csproj
Keycloak.AuthServices.Sdk.csproj --> Keycloak.AuthServices.Common.csproj
Blazor.Client.csproj --> Blazor.Shared.csproj
Blazor.Server.csproj --> Blazor.Shared.csproj
Keycloak.AuthServices.Authentication.Tests.csproj --> Keycloak.AuthServices.Authentication.csproj
Blazor.Server.csproj --> Keycloak.AuthServices.Authentication.csproj
AuthorizationAndCleanArchitecture.csproj --> Keycloak.AuthServices.Authentication.csproj
AuthorizationGettingStarted.csproj --> Keycloak.AuthServices.Authorization.csproj
Keycloak.AuthServices.Authentication.csproj --> Keycloak.AuthServices.Common.csproj
Keycloak.AuthServices.Sdk.Tests.csproj --> Keycloak.AuthServices.Sdk.csproj
ResourceAuthorization.csproj --> Keycloak.AuthServices.Authorization.csproj
Keycloak.AuthServices.IntegrationTests.csproj --> Keycloak.AuthServices.Authentication.csproj
AuthorizationGettingStarted.csproj --> Keycloak.AuthServices.Sdk.csproj
ResourceAuthorization.csproj --> Keycloak.AuthServices.Common.csproj
ResourceAuthorization.csproj --> Keycloak.AuthServices.Sdk.csproj
Blazor.Server.csproj --> Blazor.Client.csproj
Blazor.Server.csproj --> Keycloak.AuthServices.Authorization.csproj
TestWebApi.csproj --> Keycloak.AuthServices.Authorization.csproj
AuthGettingStarted.csproj --> Keycloak.AuthServices.Authentication.csproj
AuthorizationAndCleanArchitecture.csproj --> Keycloak.AuthServices.Authorization.csproj
Keycloak.AuthServices.Authentication.Tests.csproj --> Keycloak.AuthServices.Common.csproj
Keycloak.AuthServices.IntegrationTests.csproj --> TestWebApi.csproj
TestWebApiWithControllers.csproj --> Keycloak.AuthServices.Authorization.csproj
Keycloak.AuthServices.IntegrationTests.csproj --> Keycloak.AuthServices.Authorization.csproj
AuthorizationAndCleanArchitecture.csproj --> Keycloak.AuthServices.Sdk.csproj
WebApp.csproj --> Keycloak.AuthServices.Authentication.csproj
Keycloak.AuthServices.IntegrationTests.csproj --> Keycloak.AuthServices.Common.csproj
Keycloak.AuthServices.IntegrationTests.csproj --> TestWebApiWithControllers.csproj
classDef project fill:#74200154;
classDef package fill:#22aaee;
```
### API
You can use the API to build your own tools.
```bash
dotnet add package Dependify.Core
```
```csharp
var services = new ServiceCollection()
.AddLogging()
.AddSingleton()
.AddSingleton();
var provider = services.BuildServiceProvider();
var locator = provider.GetRequiredService();
var msBuildService = provider.GetRequiredService();
var nodes = locator.FullScan("C:\\Users\\joel\\source\\repos\\Dependify");
var solution = nodes.OfType().FirstOrDefault();
var graph = msBuildService.AnalyzeReferences(solution, MsBuildConfig.Default);
var subgraph = graph.SubGraph(n => n.Id.Contains("AwesomeProjectName"));
```
## Build and Development
`dotnet cake --target build`
`dotnet cake --target test`
`dotnet cake --target pack`
`dotnet tool install --global --add-source ./Artefacts Dependify.Cli --prerelease`
`dotnet tool uninstall Dependify.Cli -g`
```bash
dotnet watch run --project ./src/Dependify.Cli/ -- \
serve $dev/cap-aspire/ \
--endpoint "http://localhost:1234/v1/chat/completions" \
--model-id "LM Studio Community/Meta-Llama-3-8B-Instruct-GGUF" \
--api-key "lm-studio" \
--log-level "Information"
```
```bash
dotnet watch run --project ./src/Dependify.Cli/ -- \
serve $dev/cap-aspire/ \
--endpoint "" \
--deployment-name "gpt-35-turbo" \
--api-key "" \
--log-level "Information"
```
Set the API key for the AppHost with the following command:
```bash
dotnet user-secrets set "Parameters:api-key" ""
dotnet user-secrets set "Parameters:endpoint" ""
```