{"id":21480845,"url":"https://github.com/essentialkaos/shdoc","last_synced_at":"2025-07-15T12:32:49.704Z","repository":{"id":2732304,"uuid":"47222313","full_name":"essentialkaos/shdoc","owner":"essentialkaos","description":"Tool for viewing and exporting docs for shell scripts","archived":false,"fork":false,"pushed_at":"2024-11-13T09:07:31.000Z","size":341,"stargazers_count":12,"open_issues_count":1,"forks_count":0,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-11-13T10:20:04.184Z","etag":null,"topics":["bash","documentation","tool","utility","viewer"],"latest_commit_sha":null,"homepage":"https://kaos.sh/shdoc","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/essentialkaos.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-12-01T22:49:14.000Z","updated_at":"2024-07-07T23:34:20.000Z","dependencies_parsed_at":"2023-02-19T05:15:50.855Z","dependency_job_id":"ec52e67b-c26d-4ca0-926c-bedb0819470c","html_url":"https://github.com/essentialkaos/shdoc","commit_stats":null,"previous_names":[],"tags_count":19,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/essentialkaos%2Fshdoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/essentialkaos%2Fshdoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/essentialkaos%2Fshdoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/essentialkaos%2Fshdoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/essentialkaos","download_url":"https://codeload.github.com/essentialkaos/shdoc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":226038880,"owners_count":17564061,"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":["bash","documentation","tool","utility","viewer"],"created_at":"2024-11-23T12:18:22.835Z","updated_at":"2025-07-15T12:32:49.695Z","avatar_url":"https://github.com/essentialkaos.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\u003ca href=\"#readme\"\u003e\u003cimg src=\".github/images/card.svg\"/\u003e\u003c/a\u003e\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://kaos.sh/r/shdoc\"\u003e\u003cimg src=\"https://kaos.sh/r/shdoc.svg\" alt=\"GoReportCard\" /\u003e\u003c/a\u003e\n  \u003ca href=\"https://kaos.sh/y/shdoc\"\u003e\u003cimg src=\"https://kaos.sh/y/d8aa5c8aa68f43f6aa91872929a1695f.svg\" alt=\"Codacy badge\" /\u003e\u003c/a\u003e\n  \u003ca href=\"https://kaos.sh/c/shdoc\"\u003e\u003cimg src=\"https://kaos.sh/c/shdoc.svg\" alt=\"Coverage Status\" /\u003e\u003c/a\u003e\n  \u003cbr/\u003e\n  \u003ca href=\"https://kaos.sh/w/shdoc/ci\"\u003e\u003cimg src=\"https://kaos.sh/w/shdoc/ci.svg\" alt=\"GitHub Actions CI Status\" /\u003e\u003c/a\u003e\n  \u003ca href=\"https://kaos.sh/w/shdoc/codeql\"\u003e\u003cimg src=\"https://kaos.sh/w/shdoc/codeql.svg\" alt=\"GitHub Actions CodeQL Status\" /\u003e\u003c/a\u003e\n  \u003ca href=\"#license\"\u003e\u003cimg src=\".github/images/license.svg\"/\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\u003ca href=\"#usage-demo\"\u003eUsage Demo\u003c/a\u003e • \u003ca href=\"#installation\"\u003eInstallation\u003c/a\u003e • \u003ca href=\"#usage\"\u003eUsage\u003c/a\u003e • \u003ca href=\"#test--coverage-status\"\u003eTest \u0026 Coverage Status\u003c/a\u003e • \u003ca href=\"#contributing\"\u003eContributing\u003c/a\u003e • \u003ca href=\"#license\"\u003eLicense\u003c/a\u003e\u003c/p\u003e\n\n\u003cbr/\u003e\n\n`shdoc` is a tool for viewing and exporting documentation for shell scripts.\n\n### Usage Demo\n\n[![demo](https://github.com/user-attachments/assets/693ae7df-63ee-42ff-af46-e95fc652fd25)](#usage-demo)\n\n### Installation\n\n#### From source\n\nMake sure you have a working Go [1.23+](https://github.com/essentialkaos/.github/blob/master/GO-VERSION-SUPPORT.md) workspace ([instructions](https://go.dev/doc/install)), then:\n\n```bash\ngo install github.com/essentialkaos/shdoc@latest\n```\n\n#### Prebuilt binaries\n\nYou can download prebuilt binaries for Linux and macOS from [EK Apps Repository](https://apps.kaos.st/shdoc/latest).\n\nTo install the latest prebuilt version of bibop, do:\n\n```bash\nbash \u003c(curl -fsSL https://apps.kaos.st/get) shdoc\n```\n\n### Command-line completion\n\nYou can generate completion for `bash`, `zsh` or `fish` shell.\n\nBash:\n```\nsudo shdoc --completion=bash 1\u003e /etc/bash_completion.d/shdoc\n```\n\n\nZSH:\n```\nsudo shdoc --completion=zsh 1\u003e /usr/share/zsh/site-functions/shdoc\n```\n\n\nFish:\n```\nsudo shdoc --completion=fish 1\u003e /usr/share/fish/vendor_completions.d/shdoc.fish\n```\n\n### Usage\n\n\u003cimg src=\".github/images/usage.svg\" /\u003e\n\n### Test \u0026 Coverage Status\n\n| Branch | CI       | Coveralls |\n|--------|----------|-----------|\n| `master` | [![CI](https://kaos.sh/w/shdoc/ci.svg?branch=master)](https://kaos.sh/w/shdoc/ci?query=branch:master) | [![Coverage Status](https://kaos.sh/c/shdoc.svg?branch=master)](https://kaos.sh/c/shdoc?branch=master) |\n| `develop` | [![CI](https://kaos.sh/w/shdoc/ci.svg?branch=develop)](https://kaos.sh/w/shdoc/ci?query=branch:develop) | [![Coverage Status](https://kaos.sh/c/shdoc.svg?branch=develop)](https://kaos.sh/c/shdoc?branch=develop) |\n\n### Contributing\n\nBefore contributing to this project please read our [Contributing Guidelines](https://github.com/essentialkaos/.github/blob/master/CONTRIBUTING.md).\n\n### License\n\n[Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0)\n\n\u003cp align=\"center\"\u003e\u003ca href=\"https://kaos.dev\"\u003e\u003cimg src=\"https://raw.githubusercontent.com/essentialkaos/.github/refs/heads/master/images/ekgh.svg\"/\u003e\u003c/a\u003e\u003c/p\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fessentialkaos%2Fshdoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fessentialkaos%2Fshdoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fessentialkaos%2Fshdoc/lists"}