{"id":13571017,"url":"https://github.com/amiechen/pretzel","last_synced_at":"2025-04-05T09:10:00.324Z","repository":{"id":23187041,"uuid":"98375351","full_name":"amiechen/pretzel","owner":"amiechen","description":"Pretzel is Mac desktop app that shows and find keyboard shortcuts based on your current app.","archived":false,"fork":false,"pushed_at":"2023-02-27T20:56:59.000Z","size":62388,"stargazers_count":434,"open_issues_count":14,"forks_count":44,"subscribers_count":12,"default_branch":"master","last_synced_at":"2024-04-15T08:11:00.559Z","etag":null,"topics":["app","keyboard","mac-desktop","menubar","pretzel","shortcut"],"latest_commit_sha":null,"homepage":"","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/amiechen.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":"supported-apps.html","governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-07-26T03:30:35.000Z","updated_at":"2024-08-01T14:31:42.819Z","dependencies_parsed_at":"2024-08-01T14:31:39.962Z","dependency_job_id":"ad06405e-5f13-4434-8a9c-776252b55724","html_url":"https://github.com/amiechen/pretzel","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/amiechen%2Fpretzel","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/amiechen%2Fpretzel/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/amiechen%2Fpretzel/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/amiechen%2Fpretzel/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/amiechen","download_url":"https://codeload.github.com/amiechen/pretzel/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247312082,"owners_count":20918344,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["app","keyboard","mac-desktop","menubar","pretzel","shortcut"],"created_at":"2024-08-01T14:00:57.545Z","updated_at":"2025-04-05T09:09:59.966Z","avatar_url":"https://github.com/amiechen.png","language":"CSS","readme":"\u003cp align=\"left\"\u003e\n  \u003ca href=\"https://www.amie-chen.com/pretzel/\" target=\"_blank\"\u003e\n    \u003cimg alt=\"Parcel\" src=\"./screenshot/logo.png\" width=\"200\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\nPretzel is Mac desktop app that shows and search keyboard shortcuts based on your current app. [Checkout the landing page here.](https://www.amie-chen.com/pretzel)\n\n## Features\n\n* 🔍 In-App quick search: Find your specific shortcut with quick search among hundreds.\n* ⚡ Detects the currently focused app.\n* 🐠 Little distraction from your current task. Clicking on the menubar icon or hit `CmdorCtrl + (backtick)` on keyboard will automatically opens the shortcut panel.\n\n![app-screen-shot](./screenshot/app-screen.png)\n\n## Download for Mac\n\n[Download the latest release](https://github.com/amiechen/pretzel/releases)\n\n## Run it locally (if you are curious):\n\n### Important: Use v8 Node\nBecause Pretzel has a dependency [node-ffi](https://github.com/node-ffi/node-ffi) that requires node v8, until `node-ffi` is compaitable with \nlatest node, you should use `nvm` to install node v8 to run Pretzel locally. Otherwise, `npm install` would give you some error regarding node-gyp.\n\n```\nnvm install 8.11.3 # I personally use this version\nnvm ls # to make sure we are currently using node v8\n\nnpm install\nnpm start\n```\n\nCompile Scss\n\n```\nsass --watch sass/main.scss:main.css\n```\n\nTo compile:\n\n```\nnpm run build:mac\nnpm run build:win\n```\n\n## Add a shortcut:\n\nIf you **have** github account, please [check the roadmap first](https://github.com/amiechen/pretzel/projects/1?add_cards_query=is%3Aopen) then read [the Contributing doc here](./docs/CONTRIBUTING.md)\n\nIf you **don't have** a github account, please check the [roadmap first](https://github.com/amiechen/pretzel/projects/1?add_cards_query=is%3Aopen). If you don't see desired apps under development, follow these steps:\n\n1.  Create a text file with \u003cyour-app-name\u003e.yml as the file name. For example, `Photoshop.yml`.\n2.  Find your app's shortcuts on the web and add them to your `.yml` file, in the same format as the files in `/shortcuts` folder.\n3.  Send me the `.yml` file so I could add it in.\n\n## License\n\nMIT © [Amie Chen](https://amie-chen.com)\n","funding_links":[],"categories":["CSS","Other","Apps"],"sub_categories":["Window Management","Open Source"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Famiechen%2Fpretzel","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Famiechen%2Fpretzel","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Famiechen%2Fpretzel/lists"}