{"id":16700044,"url":"https://github.com/clok/cdocs","last_synced_at":"2026-03-08T01:34:19.607Z","repository":{"id":38975654,"uuid":"287100486","full_name":"clok/cdocs","owner":"clok","description":"Enhanced version of the ToMarkdown and ToMan methods for https://github.com/urfave/cli/v2.","archived":false,"fork":false,"pushed_at":"2026-03-05T11:02:37.000Z","size":75,"stargazers_count":1,"open_issues_count":10,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-03-05T15:21:41.226Z","etag":null,"topics":["cli","docs","extension","manpage","markdown","urfave-cli"],"latest_commit_sha":null,"homepage":"https://pkg.go.dev/github.com/clok/cdocs?tab=overview","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/clok.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2020-08-12T19:38:36.000Z","updated_at":"2022-04-07T13:10:15.000Z","dependencies_parsed_at":"2024-07-25T00:46:41.753Z","dependency_job_id":"45b77f9f-8248-4cfc-a5c7-c903ea997e99","html_url":"https://github.com/clok/cdocs","commit_stats":{"total_commits":41,"total_committers":4,"mean_commits":10.25,"dds":0.5853658536585367,"last_synced_commit":"484107d5d0c3d0a4d19ecb326659f1aa8c2e5bc4"},"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"purl":"pkg:github/clok/cdocs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clok%2Fcdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clok%2Fcdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clok%2Fcdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clok%2Fcdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/clok","download_url":"https://codeload.github.com/clok/cdocs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clok%2Fcdocs/sbom","scorecard":{"id":292060,"data":{"date":"2025-08-11","repo":{"name":"github.com/clok/cdocs","commit":"8fd267426db184e6302a8d2bb22c175983fc8a81"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.4,"checks":[{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Code-Review","score":0,"reason":"Found 0/17 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint.yml:8: update your workflow using https://app.stepsecurity.io/secureworkflow/clok/cdocs/lint.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/lint.yml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/clok/cdocs/lint.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/clok/cdocs/release.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/clok/cdocs/release.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/clok/cdocs/release.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/clok/cdocs/test.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/clok/cdocs/test.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/test.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/clok/cdocs/test.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/test.yml:32: update your workflow using https://app.stepsecurity.io/secureworkflow/clok/cdocs/test.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/warm.yaml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/clok/cdocs/warm.yaml/main?enable=pin","Info:   0 out of   5 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   5 third-party GitHubAction dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/lint.yml:1","Warn: no topLevel permission defined: .github/workflows/release.yml:1","Warn: no topLevel permission defined: .github/workflows/test.yml:1","Warn: no topLevel permission defined: .github/workflows/warm.yaml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'main'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 14 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-17T18:30:12.858Z","repository_id":38975654,"created_at":"2025-08-17T18:30:12.859Z","updated_at":"2025-08-17T18:30:12.859Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30240901,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-08T00:58:18.660Z","status":"ssl_error","status_checked_at":"2026-03-08T00:55:48.608Z","response_time":53,"last_error":"SSL_read: 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":["cli","docs","extension","manpage","markdown","urfave-cli"],"created_at":"2024-10-12T18:09:08.841Z","updated_at":"2026-03-08T01:34:19.583Z","avatar_url":"https://github.com/clok.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# cdocs - urfave/cli/v2 docs extension\n\n[![License: MIT](https://img.shields.io/badge/License-MIT-brightgreen.svg)](https://github.com/clok/cdocs/blob/master/LICENSE)\n[![Go Report Card](https://goreportcard.com/badge/clok/cdocs)](https://goreportcard.com/report/clok/cdocs)\n[![Coverage Status](https://coveralls.io/repos/github/clok/cdocs/badge.svg)](https://coveralls.io/github/clok/cdocs)\n[![go.dev reference](https://img.shields.io/badge/go.dev-reference-007d9c?logo=go\u0026logoColor=white)](https://pkg.go.dev/github.com/clok/cdocs?tab=overview)\n\nThis is an enhanced version of the `ToMarkdown` and `ToMan` methods for [https://github.com/urfave/cli/v2](https://github.com/urfave/cli).\n\n`cdocs` also provides a helper command [`InstallManpageCommand`](https://pkg.go.dev/github.com/clok/cdocs?tab=doc#InstallManpageCommand) that will generate a CLI command to install a man page to the system for the CLI tool.\n\nKey differences are:\n\n- Addition of a Table of Contents with working markdown links.\n- `UsageText` included in generated doc files.\n- [`InstallManpageCommand`](https://pkg.go.dev/github.com/clok/cdocs?tab=doc#InstallManpageCommand) helper command.\n\nExamples:\n- [gwsm](https://github.com/GoodwayGroup/gwsm/blob/master/docs/gwsm.md)\n- [gwvault](https://github.com/GoodwayGroup/gwvault/blob/master/docs/gwvault.md)\n- [gw-aws-audit](https://github.com/GoodwayGroup/gw-aws-audit/blob/master/docs/gw-aws-audit.md)\n\n## Usage\n\n```go\npackage main\n\nimport (\n\t\"fmt\"\n\t\"log\"\n\t\"os\"\n\t\"time\"\n\n\t\"github.com/clok/cdocs\"\n\t\"github.com/urfave/cli/v2\"\n)\n\nfunc main() {\n\tim, err := cdocs.InstallManpageCommand(\u0026cdocs.InstallManpageCommandInput{\n\t\tAppName: \"demo\",\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tapp := \u0026cli.App{\n\t\tName:     \"demo\",\n\t\tVersion:  \"0.0.1\",\n\t\tCompiled: time.Now(),\n\t\tAuthors: []*cli.Author{\n\t\t\t{\n\t\t\t\tName:  \"John Doe\",\n\t\t\t\tEmail: \"j@doe.com\",\n\t\t\t},\n\t\t},\n\t\tHelpName:             \"demo\",\n\t\tUsage:                \"a demo cli app\",\n\t\tEnableBashCompletion: true,\n\t\tCommands: []*cli.Command{\n\t\t\t{\n\t\t\t\tName:  \"s3\",\n\t\t\t\tUsage: \"simple S3 commands\",\n\t\t\t\tSubcommands: []*cli.Command{\n\t\t\t\t\t{\n\t\t\t\t\t\tName:      \"get\",\n\t\t\t\t\t\tUsage:     \"[object path] [destination path]\",\n\t\t\t\t\t\tUsageText: \"it's going to get an object\",\n\t\t\t\t\t\tAction: func(c *cli.Context) error {\n\t\t\t\t\t\t\tfmt.Println(\"get\")\n\t\t\t\t\t\t\treturn nil\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\tim,\n\t\t\t{\n\t\t\t\tName:    \"version\",\n\t\t\t\tAliases: []string{\"v\"},\n\t\t\t\tUsage:   \"Print version info\",\n\t\t\t\tAction: func(c *cli.Context) error {\n\t\t\t\t\tfmt.Println(\"version\")\n\t\t\t\t\treturn nil\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t}\n\n\tif os.Getenv(\"DOCS_MD\") != \"\" {\n\t\tdocs, err := cdocs.ToMarkdown(app)\n\t\tif err != nil {\n\t\t\tpanic(err)\n\t\t}\n\t\tfmt.Println(docs)\n\t\treturn\n\t}\n\n\tif os.Getenv(\"DOCS_MAN\") != \"\" {\n\t\tdocs, err := cdocs.ToMan(app)\n\t\tif err != nil {\n\t\t\tpanic(err)\n\t\t}\n\t\tfmt.Println(docs)\n\t\treturn\n\t}\n\n\terr = app.Run(os.Args)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n}\n```\n\n## Development\n\n1. Fork the [clok/cdocs](https://github.com/clok/cdocs) repo\n1. Use `go \u003e= 1.16`\n1. Branch \u0026 Code\n1. Run linters :broom: `golangci-lint run`\n    - The project uses [golangci-lint](https://golangci-lint.run/usage/install/#local-installation)\n1. Commit with a Conventional Commit\n1. Open a PR","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fclok%2Fcdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fclok%2Fcdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fclok%2Fcdocs/lists"}