{"id":28398267,"url":"https://github.com/archetypicalsoftware/vdk-template","last_synced_at":"2026-03-06T12:31:15.493Z","repository":{"id":295480627,"uuid":"983004269","full_name":"ArchetypicalSoftware/VDK-Template","owner":"ArchetypicalSoftware","description":"VDK Template Repository","archived":false,"fork":false,"pushed_at":"2026-01-30T21:42:11.000Z","size":120,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2026-01-31T13:15:39.027Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","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/ArchetypicalSoftware.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-05-13T18:20:38.000Z","updated_at":"2026-01-30T21:42:10.000Z","dependencies_parsed_at":"2025-05-25T20:20:50.056Z","dependency_job_id":"900ebd91-e8f6-4d58-b10d-4f4a8f4c0b9c","html_url":"https://github.com/ArchetypicalSoftware/VDK-Template","commit_stats":null,"previous_names":["archetypicalsoftware/vdk-template"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/ArchetypicalSoftware/VDK-Template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ArchetypicalSoftware%2FVDK-Template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ArchetypicalSoftware%2FVDK-Template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ArchetypicalSoftware%2FVDK-Template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ArchetypicalSoftware%2FVDK-Template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ArchetypicalSoftware","download_url":"https://codeload.github.com/ArchetypicalSoftware/VDK-Template/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ArchetypicalSoftware%2FVDK-Template/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30176128,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-06T11:48:51.886Z","status":"ssl_error","status_checked_at":"2026-03-06T11:48:51.460Z","response_time":250,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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-06-01T04:38:00.775Z","updated_at":"2026-03-06T12:31:15.457Z","avatar_url":"https://github.com/ArchetypicalSoftware.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# VDK-Template\nVDK Template Repository\n\n---\n\n## 🚀 Quick Installation\n\nTo install and set up this template in one step, run the following command in your terminal:\n\n```bash\nbash -c \"$(curl -fsSL https://vdk.sh/install.sh)\"\n```\n\n- This command will:\n  1. Check if you have [devbox](https://www.jetify.com/devbox) installed, and install it if missing.\n  2. Download the latest `devbox.json` and `init.sh` from this repository.\n  3. Print helpful status/error messages and exit if anything fails.\n\n---\n\n## Requirements\nThe VDK is designed to run inside a devbox shell.  You will need a Linux-based system with Docker installed to run the VDK. You can download and install Docker from [Docker's official website](https://www.docker.com/products/docker-desktop). (On Windows, you can use Docker Desktop for Windows and WSL)\nDevBox will automatically configure your shell environment for you and download the latest version of the VDK CLI.\n\n## Installation/Setup\nSetting up a Vega development environment can be complex, but with this template repository, you can quickly get started. Follow these steps to set up your development environment:\n1. Clone the repository to your local machine using Git: (ex. `git clone https://github.com/ArchetypicalSoftware/VDK-Template`)\n2. Switch to the cloned repository directory: (ex. `cd VDK-Template`)\n3. Run command `devbox shell` to initialize the DevBox environment.\n\n## Usage\nFor each development session, simply switch to your repository and start a devbox shell again with the command `devbox shell`. \n\n### Vega CLI Commands\n\n#### vega create cluster\nDescription: Create a Vega development cluster\n\nUsage: vega create cluster [options]\n\nOptions:\n\n  -n, --Name \u003cName\u003e                            The name of the kind cluster to create. [default: vdk]\n\n  -c, --ControlPlaneNodes \u003cControlPlaneNodes\u003e  The number of control plane nodes in the cluster. [default: 1]\n\n  -w, --Workers \u003cWorkers\u003e                      The number of worker nodes in the cluster. [default: 2]\n\n  -k, --KubeVersion \u003cKubeVersion\u003e              The kubernetes api version. [default: 1.29]\n\n  -?, -h, --help                               Show help and usage information\n\n__Examples__\n```\n    # Create a default cluster with 1 control plane node and 2 worker nodes named vdk\n    vega create cluster\n    \n    # Create a cluster with 2 control plane nodes and 3 worker nodes named mycluster with kubernetes version 1.32\n\n    vega create cluster -n mycluster -c 2 -w 3 -k 1.32\n```\n\n#### vega create registry\nDescription: Create Vega VDK Container Registry (A docker registry accessible from your local machine and your clusters - i.e. you can push test images here and pull them into your local cluster)\n\nUsage: vega create registry [options]\n\nOptions:\n\n  -?, -h, --help  Show help and usage information\n\n\u003e This command is automatically run during init and should not need to be run again unless something becomes corrupted on your environment.\n\n#### vega create proxy\nDescription: Create a Vega VDK Proxy Container (Enables basic connection to resources in your cluster(s))\n\nUsage: vega create proxy [options]\n\nOptions:\n\n  -?, -h, --help  Show help and usage information\n\n\u003e This command is automatically run during init and should not need to be run again unless something becomes corrupted on your environment.\n\n#### vega remove cluster\nDescription: Remove a Vega development cluster (Remove a cluster you are no longer using or has become \"dirty\" to allow you to create a fresh environment)\n\nUsage: vega remove cluster [options]\n\nOptions:\n\n  -n, --Name \u003cName\u003e  The name of the cluster to remove [default: vdk]\n\n  -?, -h, --help     Show help and usage information\n\n__Examples__\n```\n    # Remove default cluster (named \"vdk\")\n    vega remove cluster\n\n    # Remove a cluster named \"sample\"\n    vega remove cluster -n sample\n```\n\n#### vega remove registry\nDescription:  Remove Vega VDK Container Registry\n\nUsage: vega remove registry [options]\n\nOptions:\n\n  -?, -h, --help  Show help and usage information\n\n\u003e Not generally used, unless your environment has been corrupted.\n\n#### vega remove proxy\nDescription: Remove the Vega VDK Proxy\n\nUsage: vega remove proxy [options]\n\nOptions:\n  \n  -?, -h, --help  Show help and usage information\n\n\u003e Not generally used, unless your environment has been corrupted.\n\n\n#### vega list clusters\nDescription: List Vega development clusters\n\nUsage: vega list clusters [options]\n\nOptions:\n\n  -?, -h, --help  Show help and usage information\n\n#### vega list kubernetes-versions\nDescription: List available kubernetes versions\n\nUsage: vega list kubernetes-versions [options]\n\nOptions:\n\n  -?, -h, --help  Show help and usage information\n\n#### vega init\nDescription: Initialize environment.  This is generally only run once.  It will automatically create a new cluster with the default kubernetes version and settings, configure the vega proxy and set up the vega registry locally.\n\nUsage: vega init [options]\n\nOptions:\n\n  -?, -h, --help  Show help and usage information\n\n\n#### vega update kind-version-info\nDescription: Update kind version info (Maps kind and Kubernetes versions/enables new releases of kubernetes in vega)\n\nUsage: vega update kind-version-info [options]\n\nOptions:\n\n  -?, -h, --help  Show help and usage information\n\n\u003e This command is generally not required to be run by developers as it is automatically performed by the vega cli periodically.  ","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farchetypicalsoftware%2Fvdk-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Farchetypicalsoftware%2Fvdk-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farchetypicalsoftware%2Fvdk-template/lists"}