{"id":16015824,"url":"https://github.com/madworx/docshell","last_synced_at":"2025-04-05T03:22:27.328Z","repository":{"id":85312052,"uuid":"139833476","full_name":"madworx/docshell","owner":"madworx","description":"A novel approach to documenting command line tools written in shell-script.","archived":false,"fork":false,"pushed_at":"2020-08-23T19:01:36.000Z","size":56,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-17T17:59:42.814Z","etag":null,"topics":["bash","dash","documentation-tool","ksh93","posh","shell-script","shell-scripting"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"unlicense","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/madworx.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"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}},"created_at":"2018-07-05T10:27:51.000Z","updated_at":"2022-09-20T11:44:04.000Z","dependencies_parsed_at":null,"dependency_job_id":"316fb765-abf7-494f-9c54-049701631916","html_url":"https://github.com/madworx/docshell","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/madworx%2Fdocshell","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/madworx%2Fdocshell/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/madworx%2Fdocshell/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/madworx%2Fdocshell/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/madworx","download_url":"https://codeload.github.com/madworx/docshell/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247281615,"owners_count":20913203,"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","dash","documentation-tool","ksh93","posh","shell-script","shell-scripting"],"created_at":"2024-10-08T15:43:18.479Z","updated_at":"2025-04-05T03:22:27.291Z","avatar_url":"https://github.com/madworx.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Build Status](https://travis-ci.org/madworx/docshell.svg?branch=master)](https://travis-ci.org/madworx/docshell)\n\n# docshell\n_A  novel  approach  to  documenting command  line  tools  written  in\nshell-script._\n\n## Rationale\n\nTypically in Software development, documentation  has a tendency to be\nperceived  as  being  boring  to   do  all  fall  behind  the  regular\ndevelopment process.\n\nBy keeping documentation tightly knit  to the source code, we increase\nthe  likelihood  of  the  documentation  being  up-to-date;  For  more\nadvanced  programming   languages,  there's   already  lots   of  good\nframeworks for this.\n\nShell-scripts  prove to  be an  interesting domain  in that  aspect --\nshell-scripts are  typically expected to be  portable across operating\nsystems, shell language variants; There  also, de facto, doesn't exist\na  *single*  authoritative  specification  on  how  the  \"language\"(s)\nactually  works,  and different  vendors  have  over time  implemented\ndifferent functionality.\n\n## Goals\n\nThree important  factors are:\n\n  * portability  (_being able  to run  on a  diverse set  of operating\n    systems and shell dialects_)\n\n  * low dependency on external  utilities (_not assuming that specific\n    tools are  installed in  the environment the  script is  being run\n    in_),\n\n   * as well as having a small footprint. (_low SLOC for the framework\n    itself_)\n\nBy placing the documentation  at the top of the file,  it is the first\nthing a  developer sees when  opening up the  script in the  editor --\nthis will hopefully provide a \"hint\" as to update the documentation if\ndetails in the script change.\n\nAlso, by  attempting to produce  good-looking --help  output, combined\nwith dynamic  features (such as  default value variable  expansion) we\nfurther hope  that the  developer in  question will  see the  point in\nkeeping the documentation always-up-to-date.\n\n## Compatability\n\nCompatability   with  various   shells  and   operating  systems   are\nautomatically tested and  reports are published on  the following Wiki\npage:\n\n* [Compatibility matrix](https://github.com/madworx/docshell/wiki/Compatibility-matrix)\n\n## Further reading\n\n* https://en.wikipedia.org/wiki/Literate_programming\n\n## Author\n\nMartin Kjellstrand \u003cmartin.kjellstrand@madworx.se\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmadworx%2Fdocshell","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmadworx%2Fdocshell","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmadworx%2Fdocshell/lists"}