{"id":30334871,"url":"https://github.com/scaleablewebworks/grpcdoc","last_synced_at":"2025-10-13T05:16:36.310Z","repository":{"id":205493975,"uuid":"714362627","full_name":"ScaleableWebWorks/grpcdoc","owner":"ScaleableWebWorks","description":"cli to generate comprehensive html documentation for grpc/protobuf","archived":false,"fork":false,"pushed_at":"2023-11-08T21:21:03.000Z","size":2680,"stargazers_count":9,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-13T05:16:31.785Z","etag":null,"topics":["documentation","golang","grpc","protobuf"],"latest_commit_sha":null,"homepage":"","language":"Go","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/ScaleableWebWorks.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":"2023-11-04T17:24:44.000Z","updated_at":"2024-02-15T11:04:21.000Z","dependencies_parsed_at":null,"dependency_job_id":"b66eb552-a987-4491-b60e-47d8e396f24c","html_url":"https://github.com/ScaleableWebWorks/grpcdoc","commit_stats":null,"previous_names":["scaleablewebworks/grpcdoc"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/ScaleableWebWorks/grpcdoc","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ScaleableWebWorks%2Fgrpcdoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ScaleableWebWorks%2Fgrpcdoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ScaleableWebWorks%2Fgrpcdoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ScaleableWebWorks%2Fgrpcdoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ScaleableWebWorks","download_url":"https://codeload.github.com/ScaleableWebWorks/grpcdoc/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ScaleableWebWorks%2Fgrpcdoc/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279013695,"owners_count":26085390,"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","status":"online","status_checked_at":"2025-10-13T02:00:06.723Z","response_time":61,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["documentation","golang","grpc","protobuf"],"created_at":"2025-08-18T05:01:45.868Z","updated_at":"2025-10-13T05:16:36.305Z","avatar_url":"https://github.com/ScaleableWebWorks.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# grpcdoc\n\n\u003e Create comprehensive html documentation from your grpc/protobuf files.\n\n![build workflow](https://github.com/ScaleableWebWorks/grpcdoc/actions/workflows/build.yml/badge.svg)\n![Go version](https://img.shields.io/github/go-mod/go-version/scaleablewebworks/grpcdoc)\n![License](https://img.shields.io/github/license/scaleablewebworks/grpcdoc)\n\n\n`grpcdoc` is a command line tool written in golang which takes grpc/protobuf files and generates a comprehensive html documentation for it.\n\n![Preview](examples/preview.png)\n\n## Installation\n\n### Using Homebrew\n  \n```sh\nbrew tap ScaleableWebWorks/grpcdoc\nbrew install grpcdoc\n````\n\n### Manual installation\n\n1. Go to [releases](https://github.com/ScaleableWebWorks/grpcdoc/releases)\n2. Download the latest version for your operating system\n3. Unzip the file\n4. Move the binary to a location in your path\n5. Run `grpcdoc` in your terminal\n\n## Usage example\n\n__Create a documentation for a single file__\n\n```sh\ngrpcdoc -out doc.html ./path/to/your/file.proto\n```\n\n__Create a documentation for multiple files__\n\n```sh\ngrpcdoc -out doc.html ./path/to/your/file1.proto ./path/to/your/file2.proto\n```\n\n__Read all .proto files from a directory__\n\n```sh\ngrpcdoc -out doc.html ./path/to/your/protos\n```\n\n__Create a documentation for multiple files and include a custom css file__\n\n```sh\ngrpcdoc -out doc.html -style custom.css ./path/to/your/file1.proto\n```\n\n__Read proto file from stdin__\n\n```sh\ncat ../examples/example.proto | grpcdoc \u003e doc.html\n```\n\n__Generate and serve documentation on localhost:8000__\n\n```sh\ngrpcdoc -http=:8000 ./path/to/your/file.proto\n```\n\n_For more examples and usage, please refer to the [Wiki][wiki]._\n\n## Development setup\n\nTo start development you need to have [golang](https://go.dev/dl/) installed on your system.\n\n```sh\ngit clone https://github.com/ScaleableWebWorks/grpcdoc.git\ncd grpcdoc\n\ngo get\ngo build\n```\n\n## Release History\n\n* 0.0.1\n    * Initial version Work in progress\n\n## Meta\n\nMarco Rico – [@mricog](https://twitter.com/mricog) – marco@scaleablewebworks.com\n\nDistributed under the MIT license. See ``LICENSE`` for more information.\n\n[https://github.com/ScaleableWebWorks](https://github.com/ScaleableWebWorks)\n\n## Contributing\n\n1. Fork it (\u003chttps://github.com/ScaleableWebWorks/grpcdoc/fork\u003e)\n2. Create your feature branch (`git checkout -b feature/fooBar`)\n3. Commit your changes (`git commit -am 'Add some fooBar'`)\n4. Push to the branch (`git push origin feature/fooBar`)\n5. Create a new Pull Request\n\n\u003c!-- Markdown link \u0026 img dfn's --\u003e\n[wiki]: https://github.com/ScaleableWebWorks/grpcdoc/wiki\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscaleablewebworks%2Fgrpcdoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fscaleablewebworks%2Fgrpcdoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscaleablewebworks%2Fgrpcdoc/lists"}