{"id":28495886,"url":"https://github.com/b0o/zjstatus-hints","last_synced_at":"2025-10-25T21:05:56.100Z","repository":{"id":297706300,"uuid":"997664379","full_name":"b0o/zjstatus-hints","owner":"b0o","description":"💡 zellij plugin adding context-aware key binding hints for zjstatus","archived":false,"fork":false,"pushed_at":"2025-06-17T00:45:35.000Z","size":103,"stargazers_count":12,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-06-26T10:36:06.804Z","etag":null,"topics":["zellij","zellij-plugin","zjstatus"],"latest_commit_sha":null,"homepage":"","language":"Rust","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/b0o.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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},"funding":{"github":"b0o"}},"created_at":"2025-06-06T23:30:16.000Z","updated_at":"2025-06-23T19:44:06.000Z","dependencies_parsed_at":"2025-06-07T00:35:58.989Z","dependency_job_id":null,"html_url":"https://github.com/b0o/zjstatus-hints","commit_stats":null,"previous_names":["b0o/zjstatus-hints"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/b0o/zjstatus-hints","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/b0o%2Fzjstatus-hints","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/b0o%2Fzjstatus-hints/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/b0o%2Fzjstatus-hints/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/b0o%2Fzjstatus-hints/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/b0o","download_url":"https://codeload.github.com/b0o/zjstatus-hints/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/b0o%2Fzjstatus-hints/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263165766,"owners_count":23424006,"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":["zellij","zellij-plugin","zjstatus"],"created_at":"2025-06-08T11:38:00.317Z","updated_at":"2025-10-25T21:05:51.058Z","avatar_url":"https://github.com/b0o.png","language":"Rust","funding_links":["https://github.com/sponsors/b0o"],"categories":[],"sub_categories":[],"readme":"# zjstatus-hints\n\nA [Zellij](https://github.com/zellij-org/zellij) plugin that displays context-aware key bindings for each Zellij mode. Extends the functionality of [zjstatus](https://github.com/dj95/zjstatus).\n\n![2025-06-06_16-23-55_region](https://github.com/user-attachments/assets/cfb93423-f37c-410a-aca9-a49290312d0e)\n\nhttps://github.com/user-attachments/assets/940a31a0-86de-469d-89e2-dab18a1aaca8\n\n## Rationale\n\nZjstatus is an excellent plugin, but it lacks the ability to display keybinding hints for your current mode, as the built-in Zellij status-bar plugin allows. This plugin adds that functionality to zjstatus, so you can have the best of both worlds.\n\n## Features\n\n- Shows context-aware key bindings for each Zellij mode (Normal, Pane, Tab, Resize, Move, Scroll, Search, Session)\n- Integrates seamlessly with zjstatus via named pipes\n\n## Installation\n\nFirst, install and configure [zjstatus](https://github.com/dj95/zjstatus). Then, add the zjstatus-hints plugin to your Zellij configuration:\n\n```kdl\nplugins {\n    zjstatus-hints location=\"https://github.com/b0o/zjstatus-hints/releases/latest/download/zjstatus-hints.wasm\" {\n        // Maximum number of characters to display\n        max_length 0 // 0 = unlimited\n        // String to append when truncated\n        overflow_str \"...\" // default\n        // Name of the pipe for zjstatus integration\n        pipe_name \"zjstatus_hints\" // default\n        // Hide hints in base mode (a.k.a. default mode)\n        // E.g. if you have set default_mode to \"locked\", then\n        // you can hide hints in the locked mode by setting this to true\n        hide_in_base_mode false // default\n    }\n}\n\nload_plugins {\n    // Load at startup\n    zjstatus-hints\n}\n```\n\nFinally, configure zjstatus to display the hints in your default layout (`layouts/default.kdl`):\n\n```kdl\nlayout {\n    default_tab_template {\n        children\n        pane size=1 borderless=true {\n            plugin location=\"zjstatus\" {\n                format_left   \"{mode} {tabs}\"\n\n                // You can put `{pipe_zjstatus_hints}` inside of format_left, format_center, or format_right.\n                // The pipe name should match the pipe_name configuration option from above, which is zjstatus_hints by default.\n                // e.g. pipe_\u003cpipe_name\u003e\n                format_right  \"{pipe_zjstatus_hints}{datetime} \" \n\n                // Note: this is necessary or else zjstatus won't render the pipe:\n                pipe_zjstatus_hints_format \"{output}\"\n            }\n        }\n    }\n}\n```\n\n## Configuration\n\n- `max_length`: Maximum number of characters to display (default: 0 = unlimited)\n- `overflow_str`: String to append when truncated (default: \"...\")\n- `pipe_name`: Name of the pipe for zjstatus integration (default: \"zjstatus_hints\")\n- `hide_in_base_mode`: Hide hints in base mode (a.k.a. default mode) (default: false)\n\n## TODO\n\n- [ ] configurable colors/formatting\n- [ ] more advanced mode-specific configuration\n- [ ] improved handling of long outputs\n- [ ] ability to enable/disable specific hints\n\n## License\n\n\u0026copy; 2025 Maddison Hellstrom\n\nAdapted from the built-in Zellij status-bar plugin by Brooks J Rady.\n\nMIT License\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fb0o%2Fzjstatus-hints","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fb0o%2Fzjstatus-hints","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fb0o%2Fzjstatus-hints/lists"}