{"id":15209465,"url":"https://github.com/844196/wk","last_synced_at":"2025-10-29T15:30:34.983Z","repository":{"id":252817536,"uuid":"841551674","full_name":"844196/wk","owner":"844196","description":"⌨️ which-key like menu for shell","archived":false,"fork":false,"pushed_at":"2024-12-26T20:38:10.000Z","size":42,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-06T05:43:48.701Z","etag":null,"topics":["which-key","zsh"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/844196.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":"2024-08-12T16:23:32.000Z","updated_at":"2024-12-26T20:36:47.000Z","dependencies_parsed_at":"2024-09-19T09:02:18.163Z","dependency_job_id":"45117781-eb93-4433-8385-a37085700d9b","html_url":"https://github.com/844196/wk","commit_stats":null,"previous_names":["844196/wk"],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/844196%2Fwk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/844196%2Fwk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/844196%2Fwk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/844196%2Fwk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/844196","download_url":"https://codeload.github.com/844196/wk/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238840723,"owners_count":19539602,"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":["which-key","zsh"],"created_at":"2024-09-28T07:40:20.294Z","updated_at":"2025-10-29T15:30:34.978Z","avatar_url":"https://github.com/844196.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\u003cp\u003e\u0026nbsp;\u003c/p\u003e\n\u003cimg src=\"https://github.com/user-attachments/assets/07e6f86c-9f5c-4716-a07a-140dcb38efca\" /\u003e\n\u003ch1\u003ewk\u003c/h1\u003e\n\u003csmall\u003e\u003ci\u003e:keyboard: which-key like menu for zsh\u003c/i\u003e\u003c/small\u003e\n\u003c/div\u003e\n\n## :package: Installation\n\n1. Download the latest release and put into your `$PATH`:\n\n   \u003chttps://github.com/844196/wk/releases/latest\u003e\n\n2. Activate in `$ZDOTDIR/.zshrc`:\n\n   ```shell\n   # Bind space as the leader key and comma as the major-leader key.\n   # The major-prefix \"m\" is used for the major menu.\n   eval \"$(wk init --leader ' ' --major-leader ',' --major-prefix 'm')\"\n   ```\n\n3. Restart zsh.\n\n\u003e [!TIP]\n\u003e If you want to register only the widgets, change it as follows:\n\u003e\n\u003e ```shell\n\u003e eval \"$(wk init)\"\n\u003e ```\n\n## :gear: Configuration\n\n### Config\n\n`${XDG_CONFIG_HOME:-$HOME/.config}/wk/config.yaml`\n\n```yaml\n---\ntimeout: 60000\nsymbols:\n  prompt: '❯ '\ncolors:\n  prompt: 8\n  inputKeys:\n    color: 8\n    attrs: [dim]\n  breadcrumb:\n    color: 8\n    attrs: [dim]\n  lastInputKey:\n    color: 6\n    attrs: [underline]\n  bindingKey: 5\n  separator:\n    color: 5\n    attrs: [dim]\n  group: 8\n  bindingIcon: 8\n  bindingDescription: 8\n```\n\nSee [schemas/config.json](./schemas/config.json) for more details.\n\n### Global bindings\n\n`${XDG_CONFIG_HOME:-$HOME/.config}/wk/bindings.yaml`\n\n```yaml\n---\n- key: g\n  desc: Git\n  type: bindings\n  bindings:\n    - key: p\n      desc: Push/Pull\n      type: bindings\n      bindings:\n        - key: return\n          desc: git push\n          type: command\n          buffer: 'git push origin $(git symbolic-ref --short HEAD)'\n          eval: true\n        - key: f\n          desc: git push -f\n          type: command\n          buffer: 'git push --force-with-lease --force-if-includes origin $(git symbolic-ref --short HEAD)'\n          eval: true\n        - key: l\n          type: command\n          buffer: 'git pull'\n          accept: true\n- key: y\n  desc: Yank\n  type: bindings\n  bindings:\n    - key: .\n      desc: Copy $PWD\n      type: command\n      buffer: ' echo -ne \"\\e]52;c;$(base64 \u003c(pwd | tee \u003e$TTY | sed -z ''$s/\\n$//''))\\a\"'\n      accept: true\n```\n\nSee [schemas/bindings.json](./schemas/bindings.json) for more details.\n\n### Local bindings\n\n`$PWD/wk.bindings.yaml`\n\n```yaml\n---\n- key: m\n  desc: Major\n  type: bindings\n  bindings:\n    - key: b\n      type: command\n      buffer: 'npm run build'\n      accept: true\n    - key: l\n      type: command\n      buffer: 'npm run lint'\n      accept: true\n    - key: t\n      type: command\n      buffer: 'npm run test'\n      accept: true\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F844196%2Fwk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F844196%2Fwk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F844196%2Fwk/lists"}