{"id":24117147,"url":"https://github.com/ruivalim/kctl","last_synced_at":"2025-09-10T00:15:07.299Z","repository":{"id":265981685,"uuid":"897029837","full_name":"Ruivalim/kctl","owner":"Ruivalim","description":"Welcome to kctl – a lightweight, blazing-fast CLI tool that makes managing Kubernetes easier and more intuitive. Whether you're peeking into pod logs or planning to take your Kubernetes management to the next level, kctl has got you covered.","archived":false,"fork":false,"pushed_at":"2024-12-03T16:04:02.000Z","size":26,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-28T19:20:29.054Z","etag":null,"topics":[],"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/Ruivalim.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-12-01T22:04:25.000Z","updated_at":"2024-12-03T16:02:33.000Z","dependencies_parsed_at":"2025-02-28T14:21:52.391Z","dependency_job_id":"4e3c1425-43ad-4ab8-90a1-35fb85e5c822","html_url":"https://github.com/Ruivalim/kctl","commit_stats":null,"previous_names":["ruivalim/kctl"],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/Ruivalim/kctl","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ruivalim%2Fkctl","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ruivalim%2Fkctl/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ruivalim%2Fkctl/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ruivalim%2Fkctl/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Ruivalim","download_url":"https://codeload.github.com/Ruivalim/kctl/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ruivalim%2Fkctl/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":274390270,"owners_count":25276404,"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","status":"online","status_checked_at":"2025-09-09T02:00:10.223Z","response_time":80,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":[],"created_at":"2025-01-11T07:38:24.360Z","updated_at":"2025-09-10T00:15:07.033Z","avatar_url":"https://github.com/Ruivalim.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🚀 KCTL\n\n**Version:** `0.3.0`  \n\n**Welcome to `kctl`** – a lightweight, blazing-fast CLI tool that makes managing Kubernetes easier and more intuitive. Whether you're peeking into pod logs or planning to take your Kubernetes management to the next level, `kctl` has got you covered. This is just the beginning, and we're excited to grow with your Kubernetes needs!\n\n---\n\n## ✨ Features\n- **🔥 Lightweight:** A compact binary under 100 MB for super-fast execution.\n- **🔄 Namespace Awareness:** Defaults to your current Kubernetes namespace unless specified.\n- **💡 Interactive Help:** Easily discover available actions for resources with intuitive help commands.\n- **🌐 Cross-Platform:** Works seamlessly on Linux, macOS, and Windows (see disclaimer below).\n- **🔍 Searchable Inputs:** Quickly find and interact with resources using fuzzy search for input values.\n\n---\n\n## ⚠️ Disclaimer\nWhile a Windows binary is available for download, **it has not been tested**. Use it at your own risk. If you encounter issues, please report them via [GitHub Issues](https://github.com/Ruivalim/kctl/issues).\n\n---\n\n## 🛠️ Usage\n\n```bash\nkctl [options] [resource] [action]\n```\n\n### Options:\n- `-h`, `--help` → Show help information.  \n- `-n`, `--namespace` → Specify the Kubernetes namespace (defaults to your current context if omitted).  \n- `--version` → Display current version.  \n- `--update` → Update `kctl` to the latest version.\n\n### Resources:\n- **`pod`** \n\n---\n\n### 💬 Resource-Specific Help\n\nWant to know what actions are available for a resource? Just add `-h`!  \n\n```bash\nkctl pod -h\n```\n\n**Output:**  \n```\nUsage: kctl [options] pod [action]\n\nOptions:\n    -h, --help: Show help\n    -n, --namespace: Namespace to work on\n    --version: Version output\n    --update: Update kctl to the latest version\n\nActions:\n    get\n    logs\n    describe\n    delete\n    edit\n```\n\n---\n\n### 💡 Examples\n1. **View Logs from a Pod in a Specific Namespace**\n   ```bash\n   kctl pod logs -n my-namespace\n   ```\n2. **View Logs in Your Current Namespace**\n   ```bash\n   kctl pod logs\n   ```\n3. **Discover Help**\n   ```bash\n   kctl --help\n   ```\n4. **Show Version**\n   ```bash\n   kctl --version\n   ```\n5. **Check Pod Actions**\n   ```bash\n   kctl pod -h\n   ```\n\n---\n\n## 🚀 Installation\n\n### Precompiled Binary  \n1. Head over to the [Releases](https://github.com/Ruivalim/kctl/releases) page on GitHub.  \n2. Download the binary that matches your platform:\n   - `kctl-linux`\n   - `kctl-mac`\n   - `kctl-windows` (see [Disclaimer](#-disclaimer))  \n3. Move the binary to a directory in your `PATH`. For example:\n   ```bash\n   mv kctl ~/.local/bin/kctl\n   chmod +x ~/.local/bin/kctl\n   ```\n\n4. Add `~/.local/bin` to your `PATH` if not already included:\n   ```bash\n   export PATH=$PATH:~/.local/bin\n   ```\n\n5. You're ready to roll! Verify your installation:\n   ```bash\n   kctl --help\n   ```\n\n---\n\n### Build from Source\nAre you a dev ninja? 🥷 Build it yourself!  \n1. Make sure you have [Bun](https://bun.sh/) installed.  \n2. Clone the repo:  \n   ```bash\n   git clone https://github.com/Ruivalim/kctl.git\n   cd kctl\n   ```\n3. Build the binary:  \n   ```bash\n   bun run build\n   ```\n4. Add the binary to your `PATH`:  \n   ```bash\n   mv ./kctl ~/.local/bin/kctl\n   chmod +x ~/.local/bin/kctl\n   ```\n\n5. Done! 🎉 Verify:  \n   ```bash\n   kctl --help\n   ```\n\n---\n\n## 🛣️ Roadmap\n\n| **Resource**   | **Supported Actions**            | **Planned Actions**                |\n|-----------------|----------------------------------|-------------------------------------|\n| **`pod`**      | `get`, `logs`, `describe`, `delete`, `edit` | `scale`, `restart`, `port-forward` |\n| **`deployment`** | _Not yet supported_            | `get`, `scale`, `rollout status`   |\n| **`service`**   | _Not yet supported_             | `get`, `describe`, `delete`        |\n| **`configmap`** | _Not yet supported_             | `get`, `edit`, `delete`            |\n| **`namespace`** | _Not yet supported_             | `get`, `create`, `delete`          |\n\n---\n\n## ❤️ Contributing\n\nGot a cool idea? Found a bug? Let’s build this together:  \n1. Fork the repository.  \n2. Create a feature or bugfix branch.  \n3. Submit a pull request. 🎉  \n\n---\n\n## 📜 License\n`kctl` is open-source software licensed under the [MIT License](./LICENSE).  \n\n---\n\n## **Author**\n\nCreated by **[Rui Valim](https://github.com/Ruivalim)**.\nFeel free to reach out with suggestions, feedback, or just to say hi!","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fruivalim%2Fkctl","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fruivalim%2Fkctl","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fruivalim%2Fkctl/lists"}