{"id":13524189,"url":"https://github.com/werf/kubedog","last_synced_at":"2025-05-15T23:03:52.548Z","repository":{"id":37805470,"uuid":"152135517","full_name":"werf/kubedog","owner":"werf","description":"Library to watch and follow kubernetes resources in CI/CD deploy pipelines","archived":false,"fork":false,"pushed_at":"2025-04-11T13:31:01.000Z","size":2767,"stargazers_count":677,"open_issues_count":29,"forks_count":43,"subscribers_count":16,"default_branch":"main","last_synced_at":"2025-04-11T14:48:56.123Z","etag":null,"topics":["cicd","devops","follow","helm","kubectl","kubernetes","rollout","watcher","werf"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/werf.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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":"2018-10-08T19:34:22.000Z","updated_at":"2025-04-11T13:30:42.000Z","dependencies_parsed_at":"2023-12-22T14:44:59.484Z","dependency_job_id":"52a1900d-83be-48de-be3d-327174ab7cb9","html_url":"https://github.com/werf/kubedog","commit_stats":null,"previous_names":[],"tags_count":40,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/werf%2Fkubedog","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/werf%2Fkubedog/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/werf%2Fkubedog/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/werf%2Fkubedog/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/werf","download_url":"https://codeload.github.com/werf/kubedog/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254436944,"owners_count":22070946,"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":["cicd","devops","follow","helm","kubectl","kubernetes","rollout","watcher","werf"],"created_at":"2024-08-01T06:01:07.882Z","updated_at":"2025-05-15T23:03:52.475Z","avatar_url":"https://github.com/werf.png","language":"Go","readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"doc/kubedog-logo.svg?sanitize=true\" style=\"max-height:100%;\" height=\"100\"\u003e\n\u003c/p\u003e\n\n# kubedog\n\nKubedog is a library to watch and follow Kubernetes resources in CI/CD deploy pipelines.\n\nThis library is used in the [werf CI/CD tool](https://github.com/werf/werf) to track resources during deploy process.\n\n**NOTE:** Kubedog also includes a CLI, however it provides a *minimal* interface to access library functions. CLI was created to check library features and for debug purposes. Currently, we have no plans on further improvement of CLI.\n\n## Table of Contents\n- [Install kubedog CLI](#install-kubedog-cli)\n   - [Linux/macOS](#linuxmacos)\n   - [Windows](#windows-powershell)\n   - [Alternative binary installation](#alternative-binary-installation)\n- [Usage](#usage)\n- [Community](#community)\n- [License](#license)\n\n## Install `kubedog` CLI\n\n### Linux/macOS\n\n[Install trdl](https://github.com/werf/trdl/releases/) to `~/bin/trdl`, which will manage `kubedog` installation and updates. Add `~/bin` to your $PATH.\n\nAdd `kubedog` repo to `trdl`:\n```shell\ntrdl add kubedog https://tuf.kubedog.werf.io 1 2cc56abdc649a9699074097ba60206f1299e43b320d6170c40eab552dcb940d9e813a8abf5893ff391d71f0a84b39111ffa6403a3e038b81634a40d29674a531\n```\n\nTo use `kubedog` on a workstation we recommend setting up `kubedog` _automatic activation_. For this the activation command should be executed for each new shell session. Often this is achieved by adding the activation command to `~/.bashrc` (for Bash), `~/.zshrc` (for Zsh) or to the one of the profile files, but this depends on the OS/shell/terminal. Refer to your shell/terminal manuals for more information.\n\nThis is the `kubedog` activation command for the current shell-session:\n```shell\nsource \"$(trdl use kubedog 0 stable)\"\n```\n\nTo use `kubedog` in CI prefer activating `kubedog` manually instead. For this execute the activation command in the beginning of your CI job, before calling the `kubedog` binary.\n\n### Windows (PowerShell)\n\nFollowing instructions should be executed in PowerShell.\n\n[Install trdl](https://github.com/werf/trdl/releases/) to `\u003cdisk\u003e:\\Users\\\u003cyour username\u003e\\bin\\trdl`, which will manage `kubedog` installation and updates. Add `\u003cdisk\u003e:\\Users\\\u003cyour username\u003e\\bin\\` to your $PATH environment variable.\n\nAdd `kubedog` repo to `trdl`:\n```powershell\ntrdl add kubedog https://tuf.kubedog.werf.io 1 2cc56abdc649a9699074097ba60206f1299e43b320d6170c40eab552dcb940d9e813a8abf5893ff391d71f0a84b39111ffa6403a3e038b81634a40d29674a531\n```\n\nTo use `kubedog` on a workstation we recommend setting up `kubedog` _automatic activation_. For this the activation command should be executed for each new PowerShell session. For PowerShell this is usually achieved by adding the activation command to [$PROFILE file](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_profiles).\n\nThis is the `kubedog` activation command for the current PowerShell-session:\n```powershell\n. $(trdl use kubedog 0 stable)\n```\n\nTo use `kubedog` in CI prefer activating `kubedog` manually instead. For this execute the activation command in the beginning of your CI job, before calling the `kubedog` binary.\n\n### Alternative binary installation\n\nThe recommended way to install `kubedog` is described above. Alternatively, although not recommended, you can download `kubedog` binary straight from the [GitHub Releases page](https://github.com/werf/kubedog/releases/), optionally verifying the binary with the PGP signature.\n\n## Usage\n\n* [CLI usage](doc/usage.md#cli-usage)\n* [Library usage: Multitracker](doc/usage.md#Multitracker)\n\n## Community\n\nPlease feel free to reach us via [project's Discussions](https://github.com/werf/kubedog/discussions) and [werf's Telegram group](https://t.me/werf_io) (there's [another one in Russian](https://t.me/werf_ru) as well).\n\nYou're also welcome to follow [@werf_io](https://twitter.com/werf_io) to stay informed about all important news, articles, etc.\n\n## License\n\nKubedog is an Open Source project licensed under the [Apache License](https://www.apache.org/licenses/LICENSE-2.0).\n","funding_links":[],"categories":["Go","K8S-Tools","kubernetes"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwerf%2Fkubedog","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwerf%2Fkubedog","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwerf%2Fkubedog/lists"}