{"action":"created","issue":{"url":"https://api.github.com/repos/mr-doc/mr-doc/issues/115","repository_url":"https://api.github.com/repos/mr-doc/mr-doc","labels_url":"https://api.github.com/repos/mr-doc/mr-doc/issues/115/labels{/name}","comments_url":"https://api.github.com/repos/mr-doc/mr-doc/issues/115/comments","events_url":"https://api.github.com/repos/mr-doc/mr-doc/issues/115/events","html_url":"https://github.com/mr-doc/mr-doc/issues/115","id":151304750,"number":115,"title":"Feature request / question - Best way to display command line options","user":{"login":"ORESoftware","id":11139560,"avatar_url":"https://avatars.githubusercontent.com/u/11139560?v=3","gravatar_id":"","url":"https://api.github.com/users/ORESoftware","html_url":"https://github.com/ORESoftware","followers_url":"https://api.github.com/users/ORESoftware/followers","following_url":"https://api.github.com/users/ORESoftware/following{/other_user}","gists_url":"https://api.github.com/users/ORESoftware/gists{/gist_id}","starred_url":"https://api.github.com/users/ORESoftware/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ORESoftware/subscriptions","organizations_url":"https://api.github.com/users/ORESoftware/orgs","repos_url":"https://api.github.com/users/ORESoftware/repos","events_url":"https://api.github.com/users/ORESoftware/events{/privacy}","received_events_url":"https://api.github.com/users/ORESoftware/received_events","type":"User","site_admin":false},"labels":[],"state":"closed","locked":false,"assignee":null,"milestone":null,"comments":2,"created_at":"2016-04-27T05:51:59Z","updated_at":"2016-05-15T15:28:00Z","closed_at":"2016-05-15T15:28:00Z","body":"Hi there!\r\n\r\nIs there a good way to display command line options? For example, to display the output from\r\n\r\n$ x --help\r\n\r\nfor example, with my lib, I would do:\r\n\r\n```\r\nusage: suman [file/dir] [OPTIONS]\r\n\r\noptions:\r\n    --version                           Print tool version and exit.\r\n    -h, --help                          Print this help and exit.\r\n    -v, --verbose                       Verbose output. Use multiple times for\r\n                                        more verbose.\r\n    --vv, --vverbose                    Very verbose output. There is either\r\n                                        verbose or very verbose (vverbose).\r\n    --sparse                            Sparse output. Less verbose than\r\n                                        standard.\r\n    --vsparse                           Very sparse output. Even less verbose\r\n                                        than sparse option.\r\n    --init                              Initialize Suman in your project;\r\n                                        install it globally first.\r\n    --no-tables                         No ascii tables will be outputted to\r\n                                        terminal. Accomplished also by\r\n                                        \"--vsparse\" boolean option.\r\n    --coverage                          Run Suman tests and see coverage report.\r\n    -r, --recursive                     Use this option to recurse through\r\n                                        sub-directories of tests.\r\n    --safe                              Reads files in with fs.createReadStream\r\n                                        and makes sure it's a suman test before\r\n                                        running.\r\n    -f, --force                         Force the command at hand.\r\n    --ff, --fforce                      Force the command at hand, with super\r\n                                        double force.\r\n    -p, --pipe                          Pipe data to Suman using stdout to\r\n                                        stdin.\r\n    --cnvt, --convert                   Convert Mocha test file or directory to\r\n                                        Suman test(s).\r\n    -b, --bail                          Bail upon the first test error.\r\n    --ignore-brk                        Use this option to aid in the debugging\r\n                                        of child_processes.\r\n    --rnr, --runner                     Use runner even when executing only one\r\n                                        test file.\r\n    --reporters=ARG                     Specify name of reporters to be used\r\n                                        deemed by your config file.\r\n    --reporter-paths=ARG                Specify reporters by specifying path(s)\r\n                                        to reporter module(s).\r\n    --diagnostics                       Run diagnostics to see if something may\r\n                                        be wrong with your suman.conf.js file\r\n                                        and/or project structure.\r\n    --fst, --full-stack-traces          Full stack traces will be shown for all\r\n                                        exceptions, including test failures.\r\n    --procs=INT, --processes=INT        Override config value for maximum number\r\n                                        of parallel Node.js processes.\r\n    -s, --server                        Convert Mocha test file or directory to\r\n                                        Suman test(s).\r\n    --cfg=ARG, --config=ARG             Path to the suman.conf.js file you wish\r\n                                        to use.\r\n    --gfbn=ARG, --grep-file-base-name=ARG\r\n                                        Regex string used to match file names;\r\n                                        only the basename of the file path.\r\n    --gf=ARG, --grep-file=ARG           Regex string used to match file names.\r\n    --gs=ARG, --grep-suite=ARG          Path to the suman.conf.js file you wish\r\n                                        to use.\r\n    --sn=ARG, --server-name=ARG         Path to the suman.conf.js file you wish\r\n                                        to use.\r\n    --tlrnr, --tail-runner              Option to tail the suman-err.log file\r\n                                        defined by the path in your suman\r\n                                        config.\r\n    --tltst, --tail-test                Option to tail the suman-err.log file\r\n                                        defined by the path in your suman\r\n                                        config.\r\n\r\n```\r\n\r\nfor now, I could use markdown, just wondering if there is a more structure way to do this?\r\n\r\nthanks!"},"comment":{"url":"https://api.github.com/repos/mr-doc/mr-doc/issues/comments/219292200","html_url":"https://github.com/mr-doc/mr-doc/issues/115#issuecomment-219292200","issue_url":"https://api.github.com/repos/mr-doc/mr-doc/issues/115","id":219292200,"user":{"login":"iwatakeshi","id":1505448,"avatar_url":"https://avatars.githubusercontent.com/u/1505448?v=3","gravatar_id":"","url":"https://api.github.com/users/iwatakeshi","html_url":"https://github.com/iwatakeshi","followers_url":"https://api.github.com/users/iwatakeshi/followers","following_url":"https://api.github.com/users/iwatakeshi/following{/other_user}","gists_url":"https://api.github.com/users/iwatakeshi/gists{/gist_id}","starred_url":"https://api.github.com/users/iwatakeshi/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/iwatakeshi/subscriptions","organizations_url":"https://api.github.com/users/iwatakeshi/orgs","repos_url":"https://api.github.com/users/iwatakeshi/repos","events_url":"https://api.github.com/users/iwatakeshi/events{/privacy}","received_events_url":"https://api.github.com/users/iwatakeshi/received_events","type":"User","site_admin":false},"created_at":"2016-05-15T15:28:00Z","updated_at":"2016-05-15T15:28:00Z","body":"Since I haven't heard anything back, I will close this issue for now."}}