{"id":16838152,"url":"https://github.com/boreq/guinea","last_synced_at":"2026-02-28T08:34:58.567Z","repository":{"id":57495820,"uuid":"75562322","full_name":"boreq/guinea","owner":"boreq","description":"Go library for building command line interfaces.","archived":false,"fork":false,"pushed_at":"2024-12-06T13:07:43.000Z","size":18,"stargazers_count":62,"open_issues_count":1,"forks_count":2,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-08-14T03:29:22.601Z","etag":null,"topics":["cli","command-line","go","golang"],"latest_commit_sha":null,"homepage":"https://pkg.go.dev/github.com/boreq/guinea","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/boreq.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":"2016-12-04T20:24:29.000Z","updated_at":"2024-12-06T13:07:47.000Z","dependencies_parsed_at":"2025-01-06T12:27:12.770Z","dependency_job_id":"b2730d04-9dac-40a5-8ad5-49d47e6605d4","html_url":"https://github.com/boreq/guinea","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/boreq/guinea","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boreq%2Fguinea","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boreq%2Fguinea/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boreq%2Fguinea/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boreq%2Fguinea/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/boreq","download_url":"https://codeload.github.com/boreq/guinea/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boreq%2Fguinea/sbom","scorecard":{"id":248295,"data":{"date":"2025-08-11","repo":{"name":"github.com/boreq/guinea","commit":"3b68184bf0c556673921a9916b4ecd8a9496a11b"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.4,"checks":[{"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":"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":"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":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/ci.yml: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":"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":"Code-Review","score":0,"reason":"Found 1/19 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":"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/ci.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/boreq/guinea/ci.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/boreq/guinea/ci.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/boreq/guinea/ci.yml/master?enable=pin","Info:   0 out of   3 GitHub-owned 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":"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":"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":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"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":"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 5 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-17T07:59:19.680Z","repository_id":57495820,"created_at":"2025-08-17T07:59:19.680Z","updated_at":"2025-08-17T07:59:19.680Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29928859,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-27T19:37:42.220Z","status":"online","status_checked_at":"2026-02-28T02:00:07.010Z","response_time":90,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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","command-line","go","golang"],"created_at":"2024-10-13T12:21:13.349Z","updated_at":"2026-02-28T08:34:58.550Z","avatar_url":"https://github.com/boreq.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# guinea [![CI](https://github.com/boreq/guinea/actions/workflows/ci.yml/badge.svg)](https://github.com/boreq/guinea/actions/workflows/ci.yml) [![Go Reference](https://pkg.go.dev/badge/github.com/boreq/guinea.svg)](https://pkg.go.dev/github.com/boreq/guinea)\n\nGuinea is a command line interface library.\n\n## Description\nPrograms very often organise the user interface in the form of subcommands. As\nan example the `go` command lets the user invoke multiple subcommands such as\n`go build` or `go get`. This library lets you nest any numbers of subcommands\n(which can be thought of as separate programs) in each other easily building\ncomplex user interfaces.\n\n\n## Example\nThis program implements a root command which displays the program version and\ntwo subcommands.\n\n    package main\n\n    import (\n    \t\"fmt\"\n    \t\"github.com/boreq/guinea\"\n    \t\"os\"\n    )\n\n    var rootCommand = guinea.Command{\n    \tOptions: []guinea.Option{\n    \t\tguinea.Option{\n    \t\t\tName:        \"version\",\n    \t\t\tType:        guinea.Bool,\n    \t\t\tDescription: \"Display version\",\n    \t\t},\n    \t},\n    \tRun: func(c guinea.Context) error {\n    \t\tif c.Options[\"version\"].Bool() {\n    \t\t\tfmt.Println(\"v0.0.0-dev\")\n    \t\t\treturn nil\n    \t\t}\n    \t\treturn guinea.ErrInvalidParms\n    \t},\n    \tSubcommands: map[string]*guinea.Command{\n    \t\t\"display_text\": \u0026commandDisplayText,\n    \t\t\"greet\":        \u0026commandGreet,\n    \t},\n    \tShortDescription: \"an example program using the guinea library\",\n    \tDescription:      `This program demonstrates the use of a CLI library.`,\n    }\n\n    var commandDisplayText = guinea.Command{\n    \tRun: func(c guinea.Context) error {\n    \t\tfmt.Println(\"Hello world!\")\n    \t\treturn nil\n    \t},\n    \tShortDescription: \"displays text on the screen\",\n    \tDescription:      `This is a subcommand that displays \"Hello world!\" on the screen.`,\n    }\n\n    var commandGreet = guinea.Command{\n    \tArguments: []guinea.Argument{\n    \t\tguinea.Argument{\n    \t\t\tName:        \"person\",\n    \t\t\tMultiple:    false,\n    \t\t\tDescription: \"a person to greet\",\n    \t\t},\n    \t},\n    \tOptions: []guinea.Option{\n    \t\tguinea.Option{\n    \t\t\tName:        \"times\",\n    \t\t\tType:        guinea.Int,\n    \t\t\tDescription: \"Number of greetings\",\n    \t\t\tDefault:     1,\n    \t\t},\n    \t},\n    \tRun: func(c guinea.Context) error {\n    \t\tfor i := 0; i \u003c c.Options[\"times\"].Int(); i++ {\n    \t\t\tfmt.Printf(\"Hello %s!\\n\", c.Arguments[0])\n    \t\t}\n    \t\treturn nil\n    \t},\n    \tShortDescription: \"greets the specified person\",\n    \tDescription:      `This is a subcommand that greets the specified person.`,\n    }\n\n    func main() {\n    \tif err := guinea.Run(\u0026rootCommand); err != nil {\n    \t\tfmt.Fprintln(os.Stderr, err)\n    \t\tos.Exit(1)\n    \t}\n    }\n\nAnd here are the example invocations of the program:\n\n    $ ./main --help\n    $ ./main --version\n    $ ./main display_text\n    $ ./main hello --help\n    $ ./main hello boreq\n    $ ./main hello --times 10 boreq\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fboreq%2Fguinea","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fboreq%2Fguinea","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fboreq%2Fguinea/lists"}