{"id":20692479,"url":"https://github.com/dendrodocs/dotnet-tool","last_synced_at":"2025-04-22T17:10:43.013Z","repository":{"id":254502481,"uuid":"846592626","full_name":"dendrodocs/dotnet-tool","owner":"dendrodocs","description":"NuGet tool to analyze dotnet projects/solutions, enabling schema analysis and documentation generation.","archived":false,"fork":false,"pushed_at":"2025-03-03T08:25:51.000Z","size":90,"stargazers_count":7,"open_issues_count":4,"forks_count":3,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-15T03:46:49.026Z","etag":null,"topics":["analyzer","dendrodocs","hacktoberfest","living-documentation","roslyn"],"latest_commit_sha":null,"homepage":"","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dendrodocs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-08-23T14:32:45.000Z","updated_at":"2025-02-08T12:48:45.000Z","dependencies_parsed_at":"2024-11-11T13:17:55.316Z","dependency_job_id":"5e1f865d-b31b-4355-bb09-f18117fc0b5d","html_url":"https://github.com/dendrodocs/dotnet-tool","commit_stats":null,"previous_names":["dendrodocs/dotnet-tool"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dendrodocs%2Fdotnet-tool","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dendrodocs%2Fdotnet-tool/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dendrodocs%2Fdotnet-tool/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dendrodocs%2Fdotnet-tool/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dendrodocs","download_url":"https://codeload.github.com/dendrodocs/dotnet-tool/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250285697,"owners_count":21405297,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["analyzer","dendrodocs","hacktoberfest","living-documentation","roslyn"],"created_at":"2024-11-16T23:21:58.384Z","updated_at":"2025-04-22T17:10:42.975Z","avatar_url":"https://github.com/dendrodocs.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# DendroDocs.Tool\n\n[![Nuget][NUGET_BADGE]][NUGET_FEED] [![Coverage Status](https://coveralls.io/repos/github/dendrodocs/dotnet-tool/badge.svg?branch=main)](https://coveralls.io/github/dendrodocs/dotnet-tool?branch=main)\n\n**DendroDocs.Tool** is the successor to the [Living Documentation](https://github.com/eNeRGy164/LivingDocumentation) Analyzer, providing a solution for analyzing dotnet projects and generating detailed JSON outputs.\nThis tool is a key component of the DendroDocs ecosystem, designed to bridge the gap between evolving code and up-to-date documentation.\n\n## Features\n\nA command-line tool that analyzes dotnet projects or solutions and produces a JSON file that follows the schema defined in the [DendroDocs Schema](https://github.com/dendrodocs/schema) repository.\n\n## Shared Code\n\n**DendroDocs.Tool** uses the shared library from the [DendroDocs.Shared](https://github.com/dendrodocs/dotnet-shared-lib) repository, ensuring reusability across different parts of the DendroDocs dotnet ecosystem.\n\n## Prerequisites\n\n* .NET 8.0 SDK or newer.\n\n## Installation\n\nInstall **DendroDocs.Tool** as a dotnet global tool:\n\n```shell\ndotnet tool install --global DendroDocs.Tool\n```\n\nExample usage:\n\n```shell\ndendrodocs-analyze --solution G:\\DendroDocs\\dotnet-shared-lib\\DendroDocs.Shared.sln --output shared.json --pretty --verbose --exclude G:\\DendroDocs\\dotnet-shared-lib\\build\\_build.csproj\n```\n\n## Output\n\nThe output of **DendroDocs.Tool** is a comprehensive JSON file that conforms to the schema defined in the [DendroDocs Schema](https://github.com/dendrodocs/schema).\nThis JSON file provides a representation of your source code, which can be used to generate various types of documentation or integrate with other tools in your development pipeline.\n\n## The DendroDocs Ecosystem\n\n**DendroDocs.Tool** is part of the broader DendroDocs ecosystem.\nExplore [DendroDocs](https://github.com/dendrodocs) to find more tools, libraries, and documentation resources that help you bridge the gap between your code and its documentation.\n\n## Contributing\n\nContributions are welcome! Please feel free to create [issues](https://github.com/dendrodocs/dotnet-tool/issues) or [pull requests](https://github.com/dendrodocs/dotnet-tool/pulls).\n\n## License\n\nThis project is licensed under the MIT License.\n\n[NUGET_BADGE]: https://img.shields.io/nuget/v/DendroDocs.Tool.svg?style=plastic\n[NUGET_FEED]: https://www.nuget.org/packages/DendroDocs.Tool/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdendrodocs%2Fdotnet-tool","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdendrodocs%2Fdotnet-tool","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdendrodocs%2Fdotnet-tool/lists"}