{"id":15649819,"url":"https://github.com/pawamoy/shellman","last_synced_at":"2025-04-09T13:03:44.618Z","repository":{"id":86200217,"uuid":"65148595","full_name":"pawamoy/shellman","owner":"pawamoy","description":"Write documentation in comments and render it with templates.","archived":false,"fork":false,"pushed_at":"2025-03-27T15:20:04.000Z","size":1338,"stargazers_count":41,"open_issues_count":4,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-02T10:44:06.549Z","etag":null,"topics":["documentation","script","shell"],"latest_commit_sha":null,"homepage":"https://pawamoy.github.io/shellman/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pawamoy.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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},"funding":{"github":"pawamoy","ko_fi":"pawamoy","polar":"pawamoy","custom":["https://www.paypal.me/pawamoy"]}},"created_at":"2016-08-07T18:43:48.000Z","updated_at":"2025-03-27T15:19:48.000Z","dependencies_parsed_at":"2024-12-18T17:10:52.096Z","dependency_job_id":"519f596f-1423-4f3f-ba4a-f0e8a128e823","html_url":"https://github.com/pawamoy/shellman","commit_stats":{"total_commits":225,"total_committers":4,"mean_commits":56.25,"dds":"0.35111111111111115","last_synced_commit":"e2b62079975dbcafa0cdee6ea50d122d51572a2d"},"previous_names":[],"tags_count":22,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pawamoy%2Fshellman","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pawamoy%2Fshellman/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pawamoy%2Fshellman/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pawamoy%2Fshellman/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pawamoy","download_url":"https://codeload.github.com/pawamoy/shellman/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248045230,"owners_count":21038553,"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":["documentation","script","shell"],"created_at":"2024-10-03T12:32:09.138Z","updated_at":"2025-04-09T13:03:44.602Z","avatar_url":"https://github.com/pawamoy.png","language":"Python","funding_links":["https://github.com/sponsors/pawamoy","https://ko-fi.com/pawamoy","https://polar.sh/pawamoy","https://www.paypal.me/pawamoy"],"categories":["Python"],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://rawgit.com/pawamoy/shellman/master/logo.png\"\u003e\n\u003c/p\u003e\n\n\u003ch1 align=\"center\"\u003eShell Script Documentation\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003eWrite documentation in comments and render it with templates.\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/pawamoy/shellman/actions?query=workflow%3Aci\"\u003e\n    \u003cimg alt=\"ci\" src=\"https://github.com/pawamoy/shellman/workflows/ci/badge.svg\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://pawamoy.github.io/shellman/\"\u003e\n    \u003cimg alt=\"documentation\" src=\"https://img.shields.io/badge/docs-mkdocs%20material-blue.svg?style=flat\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://pypi.org/project/shellman/\"\u003e\n    \u003cimg alt=\"pypi\" src=\"https://img.shields.io/pypi/v/shellman.svg\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://gitpod.io/#https://github.com/pawamoy/shellman\"\u003e\n    \u003cimg alt=\"gitpod\" src=\"https://img.shields.io/badge/gitpod-workspace-blue.svg?style=flat\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://gitter.im/shellman/community\"\u003e\n    \u003cimg alt=\"gitter\" src=\"https://badges.gitter.im/join%20chat.svg\" /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n`shellman` can generate man pages, wiki pages and help text\nusing documentation written in shell scripts comments.\n\nFor example:\n\n```bash\n#!/bin/bash\n\n## \\brief Just a demo\n## \\desc This script actually does nothing.\n\nmain() {\n  case \"$1\" in\n    ## \\option -h, --help\n    ## Print this help and exit.\n    -h|--help) shellman \"$0\"; exit 0 ;;\n  esac\n}\n\n## \\usage demo [-h]\nmain \"$@\"\n```\n\nOutput when calling ``./demo -h``:\n\n```\nUsage: demo [-h]\n\nThis script actually does nothing.\n\nOptions:\n  -h, --help            Print this help and exit.\n```\n\nYou can see more examples in the documentation: https://pawamoy.github.io/shellman/.\n\n\u003ch2 align=\"center\"\u003eDemo\u003c/h2\u003e\n\u003cp align=\"center\"\u003e\u003cimg src=\"https://rawgit.com/pawamoy/shellman/master/demo.svg\"\u003e\u003c/p\u003e\n\nIn the demo above we saw the three builtin templates:\nhelptext, manpage and wikipage.\n\nYou can use your own templates\nby specifying them with the ``--template path:my/template`` syntax.\n\nYou can also write a plugin, see the docs: https://pawamoy.github.io/shellman/plugins.\n\n## Installation\n\n```bash\npip install shellman\n```\n\nWith [`uv`](https://docs.astral.sh/uv/):\n\n```bash\nuv tool install shellman\n```\n\n## Some projects using shellman\n\n- [shellm](https://github.com/shellm-org) —\n  A collection of scripts and libraries\n  built on a [core inclusion-system](https://github.com/shellm-org/core),\n  all installable with [basher](https://github.com/basherpm/basher).\n  Here are a few examples:\n  - [daemon](https://github.com/shellm-org/daemon) —\n    A library that facilitates the writing of daemonized scripts that consume\n    files in a watched directory.\n  - [debug](https://github.com/shellm-org/debug) —\n    A simple script that sets the verbose/dry-run/debug\n    Bash flags before running another script.\n  - [format](https://github.com/shellm-org/format) —\n    Format your output with style and color.\n  - [home](https://github.com/shellm-org/home) —\n    A home for your shell scripts! \n  - [loop](https://github.com/shellm-org/loop) —\n    Control the flow of your loops (pause/resume/etc.).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpawamoy%2Fshellman","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpawamoy%2Fshellman","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpawamoy%2Fshellman/lists"}