{"id":13903073,"url":"https://github.com/kbst/kbst","last_synced_at":"2025-10-25T21:38:00.161Z","repository":{"id":40408389,"uuid":"277793565","full_name":"kbst/kbst","owner":"kbst","description":"Kubestack framework CLI","archived":false,"fork":false,"pushed_at":"2023-04-14T19:22:54.000Z","size":2126,"stargazers_count":40,"open_issues_count":1,"forks_count":7,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-06T12:51:46.928Z","etag":null,"topics":["cli","gitops","gitops-framework","kubernetes"],"latest_commit_sha":null,"homepage":"https://www.kubestack.com","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/kbst.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","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}},"created_at":"2020-07-07T11:06:39.000Z","updated_at":"2025-03-17T09:47:45.000Z","dependencies_parsed_at":"2024-01-14T04:39:59.949Z","dependency_job_id":"eafa9815-3975-4cfb-824f-a3a47091223c","html_url":"https://github.com/kbst/kbst","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kbst%2Fkbst","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kbst%2Fkbst/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kbst%2Fkbst/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kbst%2Fkbst/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kbst","download_url":"https://codeload.github.com/kbst/kbst/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251860634,"owners_count":21655777,"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":["cli","gitops","gitops-framework","kubernetes"],"created_at":"2024-08-06T22:01:36.122Z","updated_at":"2025-10-25T21:38:00.029Z","avatar_url":"https://github.com/kbst.png","language":"Go","readme":"\u003cp align=\"center\"\u003e\n \u003cimg src=\"./assets/favicon.png\" alt=\"Kubestack, The Open Source Gitops Framework\" width=\"25%\" height=\"25%\" /\u003e\n\u003c/p\u003e\n\n\u003ch1 align=\"center\"\u003eKubestack CLI\u003c/h1\u003e\n\u003ch3 align=\"center\"\u003eCLI for the Kubestack GitOps Framework\u003c/h3\u003e\n\n\u003cdiv align=\"center\"\u003e\n\n[![Status](https://img.shields.io/badge/status-active-success.svg)]()\n[![GitHub Issues](https://img.shields.io/github/issues/kbst/kbst.svg)](https://github.com/kbst/kbst/issues)\n[![GitHub Pull Requests](https://img.shields.io/github/issues-pr/kbst/kbst.svg)](https://github.com/kbst/kbst/pulls)\n\n\u003c/div\u003e\n\n\u003cdiv align=\"center\"\u003e\n\n![GitHub Repo stars](https://img.shields.io/github/stars/kbst/kbst?style=social)\n![Twitter Follow](https://img.shields.io/twitter/follow/kubestack?style=social)\n\n\u003c/div\u003e\n\n\n\u003ch3 align=\"center\"\u003e\u003ca href=\"#Contributing\"\u003eJoin Our Contributors!\u003c/a\u003e\u003c/h3\u003e\n\n\u003cdiv align=\"center\"\u003e\n\n\u003ca href=\"https://github.com/kbst/kbst/graphs/contributors\"\u003e\n  \u003cimg src=\"https://contrib.rocks/image?repo=kbst/kbst\u0026max=36\" /\u003e\n\u003c/a\u003e\n\n\u003c/div\u003e\n\n## Introduction\n\n`kbst` is an all-in-one CLI to scaffold your Infrastructure as Code repository and deploy your entire platform stack locally for faster iteration.\n\nThis CLI is part of the [Kubestack Gitops framework](https://www.kubestack.com) for managing Kubernetes services based on Terraform and Kustomize.\n\n`kbst` improves the GitOps developer experience by making a number of common tasks easier.\n\u003e The CLI never makes any changes to any cloud environment. All changes are exclusively to the local environment and working directory.\n\n### Features\n* Scaffolds an Infrastructure as Code (IaC) repository ready to deploy to your target cloud environment\n* Provisions a local environment mirroring your cloud infrastructure using Kubernetes in Docker (KinD)\n* Watches for changes in configuration files and re-deploys parts of infrastructure to immediately reflact updates\n* Provides Docker container including all tooling for interacting manually your cloud environment as needed\n\n\n## Installing kbst\n\n### Linux\n```\n# Download the latest release\ncurl -LO \"https://github.com/kbst/kbst/releases/download/$(curl -s https://www.kubestack.com/cli-latest.txt)/kbst_linux_amd64.zip\"\n\n# Extract the binary into your PATH e.g. /usr/local/bin\nsudo unzip -d /usr/local/bin/ kbst_linux_amd64.zip kbst\n\n# Verify the binary works\nkbst --version\n```\n\n### MacOS\n```\n# Download the latest release\ncurl -LO \"https://github.com/kbst/kbst/releases/download/$(curl -s https://www.kubestack.com/cli-latest.txt)/kbst_darwin_amd64.zip\"\n\n# Extract the binary into your PATH e.g. /usr/local/bin\nsudo unzip -d /usr/local/bin/ kbst_darwin_amd64.zip kbst\n\n# Verify the binary works\nkbst --version\n```\n\n### Windows\n\u003e Windows instructions require WSL2 and Docker Desktop for Windows with the WSL2 backend.\n```\n# Download the latest release\ncurl -LO \"https://github.com/kbst/kbst/releases/download/$(curl -s https://www.kubestack.com/cli-latest.txt)/kbst_linux_amd64.zip\"\n\n# Extract the binary into your PATH e.g. /usr/local/bin\nsudo unzip -d /usr/local/bin/ kbst_linux_amd64.zip kbst\n\n# Verify the binary works\nkbst --version\n```\n\n### Build from Source\n```\n# Clone the repository\ngit clone https://github.com/cctechwiz-forks/kbst.git\n\n# Enter repository directory\ncd kbst\n\n# Install binary (requires you $GOPATH/bin to be on your system $PATH)\nmake install\n```\n\n\n## Using the kbst CLI\n\n`kbst` has four commands:\n* `help` - Help about any command\n* `local` - Start a localhost development environment\n* `manifest` - Add, update, and remove services from the [catalog](https://github.com/kbst/catalog)\n* `repository` - Create and change Kubestack repositories\n\n`kbst local` has two sub-commands:\n* `apply` - Watch and apply changes to the localhost development environment\n* `destroy` - Destroy the localhost development environment\n\n`kbst manifest` has three sub-commands:\n* `install` - Install and vendor a manifest from the catalog\n* `remove` - Remove a vendored manifest from all environments\n* `update` - Update vendored manifests from the catalog\n\n`kbst repository` only has a single sub-command:\n* `init` - Scaffold a new repository\n\n\n## Getting Started with Kubestack\n\nFor the easiest way to get started, [visit the official Kubestack quickstart](https://www.kubestack.com/infrastructure/documentation/quickstart). This tutorial will help you get started with the Kubestack GitOps framework. It is divided into three steps.\n\n1. Develop Locally\n    * Scaffold your repository and tweak your config in a local development environment that simulates your actual cloud configuration using Kubernetes in Docker (KinD).\n3. Provision Infrastructure\n    * Set-up cloud prerequisites and bootstrap Kubestack's environment and clusters on your cloud provider for the first time.\n4. Set-up Automation\n    * Integrate CI/CD to automate changes following Kubestack's GitOps workflow.\n\n\n## Getting Help\n\n**Official Documentation**  \nRefer to the [official documentation](https://www.kubestack.com/framework/documentation) for a deeper dive into how to use and configure Kubetack.\n\n**Community Help**  \nIf you have any questions while following the tutorial, join the [#kubestack](https://app.slack.com/client/T09NY5SBT/CMBCT7XRQ) channel on the Kubernetes community. To create an account request an [invitation](https://slack.k8s.io/).\n\n**Professional Services**  \nFor organizations interested in accelerating their GitOps journey, [professional services](https://www.kubestack.com/lp/professional-services) are available.\n\n\n## Contributing\nContributions to the Kubestack framework are welcome and encouraged. Before contributing, please read the [Contributing](./CONTRIBUTING.md) and [Code of Conduct](./CODE_OF_CONDUCT.md) Guidelines.\n\nOne super simple way to contribute to the success of this project is to give it a star.  \n\n\u003cdiv align=\"center\"\u003e\n\n![GitHub Repo stars](https://img.shields.io/github/stars/kbst/kbst?style=social)\n\n\u003c/div\u003e\n\n\n## Kubestack Repositories\n* [kbst/terraform-kubestack](https://github.com/kbst/terraform-kubestack)  \n    * Terraform GitOps Framework - Everything you need to build reliable automation for AKS, EKS and GKE Kubernetes clusters in one free and open-source framework.\n* [kbst/kbst](https://github.com/kbst/kbst) (this repository)  \n    * Kubestack Framework CLI - All-in-one CLI to scaffold your Infrastructure as Code repository and deploy your entire platform stack locally for faster iteration.\n* [kbst/terraform-provider-kustomization](https://github.com/kbst/terraform-provider-kustomization)  \n    * Kustomize Terraform Provider - A Kubestack maintained Terraform provider for Kustomize, available in the [Terraform registry](https://registry.terraform.io/providers/kbst/kustomization/latest).\n* [kbst/catalog](https://github.com/kbst/catalog)  \n    * Catalog of cluster services as Kustomize bases - Continuously tested and updated Kubernetes services, installed and customizable using native Terraform syntax.\n\n","funding_links":[],"categories":["cli"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkbst%2Fkbst","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkbst%2Fkbst","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkbst%2Fkbst/lists"}