{"id":18309579,"url":"https://github.com/sfuhrm/args2all","last_synced_at":"2026-05-07T02:34:26.508Z","repository":{"id":78031829,"uuid":"110749084","full_name":"sfuhrm/args2all","owner":"sfuhrm","description":"Converts args4j/JCommander descriptor classes to markdown or manpages","archived":false,"fork":false,"pushed_at":"2018-06-18T21:42:07.000Z","size":171,"stargazers_count":2,"open_issues_count":5,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-06-24T15:54:26.355Z","etag":null,"topics":["args4j","java","jcommander","manpage","manpages","manual","markdown"],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sfuhrm.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":"2017-11-14T21:51:40.000Z","updated_at":"2020-06-19T01:09:44.000Z","dependencies_parsed_at":"2023-06-15T05:15:45.008Z","dependency_job_id":null,"html_url":"https://github.com/sfuhrm/args2all","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/sfuhrm/args2all","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sfuhrm%2Fargs2all","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sfuhrm%2Fargs2all/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sfuhrm%2Fargs2all/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sfuhrm%2Fargs2all/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sfuhrm","download_url":"https://codeload.github.com/sfuhrm/args2all/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sfuhrm%2Fargs2all/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32720285,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-07T02:14:30.463Z","status":"ssl_error","status_checked_at":"2026-05-07T02:14:29.405Z","response_time":62,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["args4j","java","jcommander","manpage","manpages","manual","markdown"],"created_at":"2024-11-05T16:11:52.724Z","updated_at":"2026-05-07T02:34:26.494Z","avatar_url":"https://github.com/sfuhrm.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"Args2All\n===================\n![Travis CI Status](https://travis-ci.org/sfuhrm/capsula.svg?branch=master)\n[![License: GPL v2](https://img.shields.io/badge/License-GPL%20v2-blue.svg)](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html)\n\nConverts machine readable command line parser library class annotations (args4j, JCommander)\ninto a variety of human readable text documents. To put it in other words: You document\nyour options for i.e. args4j, and then you can extract the information for other documents\nusing this tool from your Java classes.\n\nThe main purpose is to reduce overhead when documenting software.\n\nTwo examples can be seen [below](#output-formats-supported).\n\n#### Command line parsing libraries supported\n\nCurrently the following command line libraries are supported:\n* [Args4j](https://github.com/kohsuke/args4j)\n* [JCommander](https://github.com/cbeust/jcommander)\n* [PicoCLI](https://github.com/remkop/picocli)\n\n## Command line options\n\nUsage is as follows:\n\n    java -jar target/args2all-0.0.1-jar-with-dependencies.jar \u003cOPTIONS\u003e\n    \nWhere the possible options are listed here (args2all-generated):    \n\n* **-charset, -C** *=* *CHARSET*\n\n  The charset encoding to use for the output file.\n\n  \n* **-class, -c** *=* *CLASS*\n\n  Name of the annotated class to read. The annotations are from a library like args4j or JCommander. Note that the class must be loadable from the programs context, meaning reachable from the classpath.\n\n  *Required*\n* **-help, -h**\n\n  Show the command line help.\n\n  \n* **-out, -o** *=* *FILE*\n\n  The output where to write the result to.\n\n  *Required*\n* **-template, -t**\n\n  The template to use for output. This is the output flavor you are desiring to generate.\n\n\n### Output formats supported\n\nThe *all* in Args2all is quite limited at the moment. Please\nread the current options in the next sections.\n\n#### Markdown\n\nOutputs a markdown text that is inspired by the layout of UN*X manual pages.\n\nHere's an example of the program itself:\n\n![Markdown example](https://raw.githubusercontent.com/sfuhrm/args2all/master/examples/markdown.png \"Markdown example\")\n\nMarkdown code can be seen [here](https://raw.githubusercontent.com/sfuhrm/args2all/master/examples/args2all.md).\n\n#### Manpage\n\nOutputs a partial manual page / troff page that can be used as a\ntemplate. The parts of the file that need to be filled are\nmarked as pseudo-variables, for example `$DESCRIPTION`.\n\nHere's an example of the program itself:\n\n![Manpage example](https://raw.githubusercontent.com/sfuhrm/args2all/master/examples/manpage.png \"Manpage example\")\n\nManpage code can be seen [here](https://raw.githubusercontent.com/sfuhrm/args2all/master/examples/args2all.1).\n\n#### XML\n\nOutputs a XML dump that can be used for example in XML stylesheets.\n\nXML page example is located [here](https://raw.githubusercontent.com/sfuhrm/args2all/master/examples/args2all.xml).\n\n### Warnings\n\nIt is possible that the library versions used with Args2all are not\ncompatible with the versions you're using in the classes you've compiled.\nTo get around this problem, adjust the problematic library versions to\nbe the same on both sides.\n\n## License\n\nCopyright 2017 Stephan Fuhrmann\n\nLicensed under the GNU GENERAL PUBLIC LICENSE 2.0.\nPlease see the licensing conditions under [LICENSE](./LICENSE)\nor at [https://www.gnu.org/licenses/gpl-2.0.html](https://www.gnu.org/licenses/gpl-2.0.html).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsfuhrm%2Fargs2all","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsfuhrm%2Fargs2all","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsfuhrm%2Fargs2all/lists"}