{"id":15694870,"url":"https://github.com/dj95/zjk8s","last_synced_at":"2025-04-15T11:08:30.253Z","repository":{"id":225553073,"uuid":"766224538","full_name":"dj95/zjk8s","owner":"dj95","description":"Kubernetes explorer for zellij","archived":false,"fork":false,"pushed_at":"2024-11-15T15:22:10.000Z","size":80118,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-15T11:08:15.668Z","etag":null,"topics":["kubernetes","rust","wasm","zellij","zellij-plugin"],"latest_commit_sha":null,"homepage":"","language":"Rust","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/dj95.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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-03-02T17:14:32.000Z","updated_at":"2025-03-29T22:58:26.000Z","dependencies_parsed_at":"2024-03-05T20:05:17.689Z","dependency_job_id":null,"html_url":"https://github.com/dj95/zjk8s","commit_stats":null,"previous_names":["dj95/zjk8s"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dj95%2Fzjk8s","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dj95%2Fzjk8s/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dj95%2Fzjk8s/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dj95%2Fzjk8s/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dj95","download_url":"https://codeload.github.com/dj95/zjk8s/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249058370,"owners_count":21205910,"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":["kubernetes","rust","wasm","zellij","zellij-plugin"],"created_at":"2024-10-03T19:00:59.176Z","updated_at":"2025-04-15T11:08:30.204Z","avatar_url":"https://github.com/dj95.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003ezjk8s\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n  Kubernetes explorer for zellij\n  \u003cbr\u003e\u003cbr\u003e\n  \u003ca href=\"https://github.com/dj95/zjk8s/actions/workflows/lint.yml\"\u003e\n    \u003cimg alt=\"clippy check\" src=\"https://github.com/dj95/zjk8s/actions/workflows/lint.yml/badge.svg\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/dj95/zjk8s/releases\"\u003e\n    \u003cimg alt=\"latest version\" src=\"https://img.shields.io/github/v/tag/dj95/zjk8s.svg?sort=semver\" /\u003e\n  \u003c/a\u003e\n\n  \u003cbr\u003e\u003cbr\u003e\n  The goal of this plugin is to provide an easy way to explore resources in a kubernetes cluster and retrieve its details.\n\u003c/p\u003e\n\n\u003cimg src=\"./assets/demo.gif\" alt=\"Demo GIF of zellij with zjk8s\" /\u003e\n\n## 🚀 Usage\n\nzjk8s must either be downloaded to the file system or configured with a remote URL within a zellij layout, such that zellij is able to download the plugin. The following configuration must be added to the layout, in which you'd like to use zjk8s.\n\n```javascript\npane {\n    plugin location=\"https://github.com/dj95/zjk8s/releases/latest/download/zjk8s.wasm\" {\n        kubernetes_context \"k8s\"\n\n        selected_item_bg               \"#737592\"\n        selected_col_bg                \"#2a2b3e\"\n        selected_col_selected_item_bg  \"#737592\"\n    }\n}\n```\n\n\u003e [!IMPORTANT]\n\u003e In case you experience any crashes or issues, please in the first step try to clear the cache! (`$HOME/.cache/zellij/` for Linux, `$HOME/Library/Caches/org.Zellij-Contributors.Zellij/` on macOS)\n\nWhen the layout and the plugin is started, it should display the namespaces, all resource types in the first namespace and all resources of the first resource type. For larger clusters, it might take a few seconds to load all resources. When everything is loaded, navigate with the arrow keys through the lists and columns. If you press `Enter` on a resource, it will display the details of the resource on the right.\n\n## ❄️ Installation with nix flake\n\nAdd this repository to your inputs and then with the following overlay to your packages.\nThen you are able to install and refer to it with `pkgs.zjk8s`. When templating the\nconfig file, you can use `${pkgs.zjk8s}/bin/zjk8s.wasm` as the path.\n\n```nix\n  inputs = {\n    # ...\n\n    zjk8s = {\n      url = \"github:dj95/zjk8s\";\n    };\n  };\n\n\n  # define the outputs of this flake - especially the home configurations\n  outputs = { self, nixpkgs, zjstatus, ... }@inputs:\n  let\n    inherit (inputs.nixpkgs.lib) attrValues;\n\n    overlays = with inputs; [\n      # ...\n      (final: prev: {\n        zjk8s = zjk8s.packages.${prev.system}.default;\n      })\n    ];\n```\n\n## 🚧 Development\n\nMake sure you have rust and the `wasm32-wasi` target installed. If using nix, you could utilize the nix-shell\nin this repo for obtaining `cargo` and `rustup`. Then you'll only need to add the target with\n`rustup target add wasm32-wasi`.\n\nWith the toolchain, simply build `zjk8s` with `cargo build`. Then you are able to run the example configuration\nwith `zellij -l plugin-dev-workspace.kdl` from the root of the repository.\n\n## 🤝 Contributing\n\nIf you are missing features or find some annoying bugs please feel free to submit an issue or a bugfix within a pull request :)\n\n## 📝 License\n\n© 2024 Daniel Jankowski\n\nThis project is licensed under the MIT license.\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdj95%2Fzjk8s","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdj95%2Fzjk8s","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdj95%2Fzjk8s/lists"}