{"id":13400426,"url":"https://github.com/cheat/cheat","last_synced_at":"2026-02-15T22:06:35.674Z","repository":{"id":9780663,"uuid":"11753762","full_name":"cheat/cheat","owner":"cheat","description":"cheat allows you to create and view interactive cheatsheets on the command-line. It was designed to help remind *nix system administrators of options for commands that they use frequently, but not frequently enough to remember.","archived":false,"fork":false,"pushed_at":"2024-07-29T06:38:08.000Z","size":8107,"stargazers_count":13092,"open_issues_count":52,"forks_count":842,"subscribers_count":181,"default_branch":"master","last_synced_at":"2025-12-09T23:59:15.371Z","etag":null,"topics":["bash","cheat","cheatsheet","cheatsheets","documentation","help","interactive-cheatsheets","man-page"],"latest_commit_sha":null,"homepage":"","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/cheat.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","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":"2013-07-30T01:32:12.000Z","updated_at":"2025-12-08T11:05:33.000Z","dependencies_parsed_at":"2023-01-13T15:34:03.953Z","dependency_job_id":"5c15c1d4-408b-499c-9f19-a2d57fb190bc","html_url":"https://github.com/cheat/cheat","commit_stats":{"total_commits":890,"total_committers":185,"mean_commits":"4.8108108108108105","dds":0.5707865168539326,"last_synced_commit":"7908a678dfb1dd52baabeeff6f567d6d586293fb"},"previous_names":[],"tags_count":96,"template":false,"template_full_name":null,"purl":"pkg:github/cheat/cheat","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cheat%2Fcheat","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cheat%2Fcheat/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cheat%2Fcheat/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cheat%2Fcheat/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cheat","download_url":"https://codeload.github.com/cheat/cheat/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cheat%2Fcheat/sbom","scorecard":{"id":275301,"data":{"date":"2025-08-11","repo":{"name":"github.com/cheat/cheat","commit":"7908a678dfb1dd52baabeeff6f567d6d586293fb"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3,"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":"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 0/9 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":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/build.yml:1","Warn: no topLevel permission defined: .github/workflows/codeql-analysis.yml:1","Warn: no topLevel permission defined: .github/workflows/homebrew.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":"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":"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":"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":"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.txt:0","Info: FSF or OSI recognized license: MIT License: LICENSE.txt:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"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":0,"reason":"Project has not signed or included provenance with any releases.","details":["Warn: release artifact 4.4.2 not signed: https://api.github.com/repos/cheat/cheat/releases/134129180","Warn: release artifact 4.4.1 not signed: https://api.github.com/repos/cheat/cheat/releases/133754490","Warn: release artifact 4.4.0 not signed: https://api.github.com/repos/cheat/cheat/releases/82169200","Warn: release artifact 4.3.3 not signed: https://api.github.com/repos/cheat/cheat/releases/75558129","Warn: release artifact 4.3.2 not signed: https://api.github.com/repos/cheat/cheat/releases/75494293","Warn: release artifact 4.4.2 does not have provenance: https://api.github.com/repos/cheat/cheat/releases/134129180","Warn: release artifact 4.4.1 does not have provenance: https://api.github.com/repos/cheat/cheat/releases/133754490","Warn: release artifact 4.4.0 does not have provenance: https://api.github.com/repos/cheat/cheat/releases/82169200","Warn: release artifact 4.3.3 does not have provenance: https://api.github.com/repos/cheat/cheat/releases/75558129","Warn: release artifact 4.3.2 does not have provenance: https://api.github.com/repos/cheat/cheat/releases/75494293"],"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"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/build.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/cheat/cheat/build.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/cheat/cheat/build.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:34: update your workflow using https://app.stepsecurity.io/secureworkflow/cheat/cheat/build.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/cheat/cheat/build.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/cheat/cheat/codeql-analysis.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/cheat/cheat/codeql-analysis.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/cheat/cheat/codeql-analysis.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/cheat/cheat/codeql-analysis.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/homebrew.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/cheat/cheat/homebrew.yml/master?enable=pin","Warn: containerImage not pinned by hash: Dockerfile:4: pin your Docker image by updating golang:1.15-alpine to golang:1.15-alpine@sha256:b58c367d52e46cdedc25ec9cd74cadb14ad65e8db75b25e5ec117cdb227aa264","Warn: goCommand not pinned by hash: vendor/github.com/go-git/go-git/v5/oss-fuzz.sh:20","Warn: goCommand not pinned by hash: .github/workflows/build.yml:24","Warn: goCommand not pinned by hash: .github/workflows/build.yml:41","Info:   0 out of   8 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   1 third-party GitHubAction dependencies pinned","Info:   0 out of   3 goCommand dependencies pinned","Info:   0 out of   1 containerImage 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":"SAST","score":7,"reason":"SAST tool detected but not run on all commits","details":["Info: SAST configuration detected: CodeQL","Warn: 0 commits out of 26 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"}},{"name":"Vulnerabilities","score":1,"reason":"9 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GO-2025-3754 / GHSA-2x5j-vhc8-9cwm","Warn: Project is vulnerable to: GO-2025-3367 / GHSA-r9px-m959-cxf4","Warn: Project is vulnerable to: GO-2025-3368 / GHSA-v725-9546-7q7m","Warn: Project is vulnerable to: GO-2024-3321 / GHSA-v778-237x-gjrc","Warn: Project is vulnerable to: GO-2025-3487 / GHSA-hcg3-q754-cr77","Warn: Project is vulnerable to: GO-2024-2687 / GHSA-4v7x-pqxf-cx7m","Warn: Project is vulnerable to: GO-2024-3333","Warn: Project is vulnerable to: GO-2025-3503 / GHSA-qxp5-gwg8-xv66","Warn: Project is vulnerable to: GO-2025-3595 / GHSA-vvgc-356p-c3xw"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-17T14:15:04.243Z","repository_id":9780663,"created_at":"2025-08-17T14:15:04.243Z","updated_at":"2025-08-17T14:15:04.243Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29110593,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-05T03:44:17.043Z","status":"ssl_error","status_checked_at":"2026-02-05T03:44:12.077Z","response_time":65,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5: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":["bash","cheat","cheatsheet","cheatsheets","documentation","help","interactive-cheatsheets","man-page"],"created_at":"2024-07-30T19:00:51.911Z","updated_at":"2026-02-15T22:06:35.668Z","avatar_url":"https://github.com/cheat.png","language":"Go","readme":"![Workflow status](https://github.com/cheat/cheat/actions/workflows/build.yml/badge.svg)\n\n# cheat\n\n`cheat` allows you to create and view interactive cheatsheets on the\ncommand-line. It was designed to help remind \\*nix system administrators of\noptions for commands that they use frequently, but not frequently enough to\nremember.\n\n![The obligatory xkcd](http://imgs.xkcd.com/comics/tar.png 'The obligatory xkcd')\n\nUse `cheat` with [cheatsheets][].\n\n## Example\nThe next time you're forced to disarm a nuclear weapon without consulting\nGoogle, you may run:\n\n```sh\ncheat tar\n```\n\nYou will be presented with a cheatsheet resembling the following:\n\n```sh\n# To extract an uncompressed archive:\ntar -xvf '/path/to/foo.tar'\n\n# To extract a .gz archive:\ntar -xzvf '/path/to/foo.tgz'\n\n# To create a .gz archive:\ntar -czvf '/path/to/foo.tgz' '/path/to/foo/'\n\n# To extract a .bz2 archive:\ntar -xjvf '/path/to/foo.tgz'\n\n# To create a .bz2 archive:\ntar -cjvf '/path/to/foo.tgz' '/path/to/foo/'\n```\n\n## Installing\nFor installation and configuration instructions, see [INSTALLING.md][].\n\n## Usage\nTo view a cheatsheet:\n\n```sh\ncheat tar      # a \"top-level\" cheatsheet\ncheat foo/bar  # a \"nested\" cheatsheet\n```\n\nTo edit a cheatsheet:\n\n```sh\ncheat -e tar     # opens the \"tar\" cheatsheet for editing, or creates it if it does not exist\ncheat -e foo/bar # nested cheatsheets are accessed like this\n```\n\nTo view the configured cheatpaths:\n\n```sh\ncheat -d\n```\n\nTo list all available cheatsheets:\n\n```sh\ncheat -l\n```\n\nTo briefly list all cheatsheets (names and tags only):\n\n```sh\ncheat -b\n```\n\nTo list all cheatsheets that are tagged with \"networking\":\n\n```sh\ncheat -l -t networking\n```\n\nTo list all cheatsheets on the \"personal\" path:\n\n```sh\ncheat -l -p personal\n```\n\nTo search for the phrase \"ssh\" among cheatsheets:\n\n```sh\ncheat -s ssh\n```\n\nTo search (by regex) for cheatsheets that contain an IP address:\n\n```sh\ncheat -r -s '(?:[0-9]{1,3}\\.){3}[0-9]{1,3}'\n```\n\nFlags may be combined in intuitive ways. Example: to search sheets on the\n\"personal\" cheatpath that are tagged with \"networking\" and match a regex:\n\n```sh\ncheat -p personal -t networking --regex -s '(?:[0-9]{1,3}\\.){3}[0-9]{1,3}'\n```\n\n## Cheatsheets\nCheatsheets are plain-text files with no file extension, and are named\naccording to the command used to view them:\n\n```sh\ncheat tar     # file is named \"tar\"\ncheat foo/bar # file is named \"bar\", in a \"foo\" subdirectory\n```\n\nCheatsheet text may optionally be preceded by a YAML frontmatter header that\nassigns tags and specifies syntax:\n\n```\n---\nsyntax: javascript\ntags: [ array, map ]\n---\n// To map over an array:\nconst squares = [1, 2, 3, 4].map(x =\u003e x * x);\n```\n\nSyntax highlighting is provided by [Chroma][], and the `syntax` value may be\nset to any lexer name that Chroma supports. See Chroma's [supported\nlanguages][] for a complete list.\n\nThe `cheat` executable includes no cheatsheets, but [community-sourced\ncheatsheets are available][cheatsheets]. You will be asked if you would like to\ninstall the community-sourced cheatsheets the first time you run `cheat`.\n\n## Cheatpaths\nCheatsheets are stored on \"cheatpaths\", which are directories that contain\ncheatsheets. Cheatpaths are specified in the `conf.yml` file.\n\nIt can be useful to configure `cheat` against multiple cheatpaths. A common\npattern is to store cheatsheets from multiple repositories on individual\ncheatpaths:\n\n```yaml\n# conf.yml:\n# ...\ncheatpaths:\n  - name: community                   # a name for the cheatpath\n    path: ~/documents/cheat/community # the path's location on the filesystem\n    tags: [ community ]               # these tags will be applied to all sheets on the path\n    readonly: true                    # if true, `cheat` will not create new cheatsheets here\n\n  - name: personal\n    path: ~/documents/cheat/personal  # this is a separate directory and repository than above\n    tags: [ personal ]\n    readonly: false                   # new sheets may be written here\n# ...\n```\n\nThe `readonly` option instructs `cheat` not to edit (or create) any cheatsheets\non the path. This is useful to prevent merge-conflicts from arising on upstream\ncheatsheet repositories.\n\nIf a user attempts to edit a cheatsheet on a read-only cheatpath, `cheat` will\ntransparently copy that sheet to a writeable directory before opening it for\nediting.\n\n### Directory-scoped Cheatpaths\nAt times, it can be useful to closely associate cheatsheets with a directory on\nyour filesystem. `cheat` facilitates this by searching for a `.cheat` directory\nin the current working directory and its ancestors (similar to how `git` locates\n`.git` directories). The nearest `.cheat` directory found will (temporarily) be\nadded to the cheatpaths. This means you can place a `.cheat` directory at your\nproject root and it will be available from any subdirectory within that project.\n\n## Autocompletion\nShell autocompletion is currently available for `bash`, `fish`, and `zsh`. Copy\nthe relevant [completion script][completions] into the appropriate directory on\nyour filesystem to enable autocompletion. (This directory will vary depending\non operating system and shell specifics.)\n\nAdditionally, `cheat` supports enhanced autocompletion via integration with\n[fzf][]. To enable `fzf` integration:\n\n1. Ensure that `fzf` is available on your `$PATH`\n2. Set an envvar: `export CHEAT_USE_FZF=true`\n\n[INSTALLING.md]: INSTALLING.md\n[Releases]:      https://github.com/cheat/cheat/releases\n[cheatsheets]:   https://github.com/cheat/cheatsheets\n[completions]:   https://github.com/cheat/cheat/tree/master/scripts\n[Chroma]:                https://github.com/alecthomas/chroma\n[supported languages]:   https://github.com/alecthomas/chroma#supported-languages\n[fzf]:                   https://github.com/junegunn/fzf\n","funding_links":[],"categories":["Go","HarmonyOS","Python","Cheat Sheet","Applications","Cheat sheets","Tools","Uncategorized","documentation","cheatsheets"],"sub_categories":["Windows Manager","Utilities","Misc","Go","Uncategorized"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcheat%2Fcheat","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcheat%2Fcheat","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcheat%2Fcheat/lists"}