{"id":30277468,"url":"https://github.com/overlock-network/overlock","last_synced_at":"2026-01-28T16:00:45.422Z","repository":{"id":226412322,"uuid":"747273753","full_name":"overlock-network/overlock","owner":"overlock-network","description":"The Overlock Environment CLI","archived":false,"fork":false,"pushed_at":"2026-01-22T17:43:19.000Z","size":29841,"stargazers_count":38,"open_issues_count":4,"forks_count":9,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-01-23T10:41:19.013Z","etag":null,"topics":["crossplane","development","kubernetes","native","platform"],"latest_commit_sha":null,"homepage":"","language":"Go","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/overlock-network.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":".github/CODEOWNERS","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":"2024-01-23T16:00:10.000Z","updated_at":"2026-01-22T17:43:22.000Z","dependencies_parsed_at":"2024-03-26T08:32:01.012Z","dependency_job_id":"1e3e3b98-b7af-418d-bea9-87a8eec6f4aa","html_url":"https://github.com/overlock-network/overlock","commit_stats":null,"previous_names":["kndpio/cli","web-seven/overlock","overlock-network/overlock"],"tags_count":105,"template":false,"template_full_name":null,"purl":"pkg:github/overlock-network/overlock","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/overlock-network%2Foverlock","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/overlock-network%2Foverlock/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/overlock-network%2Foverlock/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/overlock-network%2Foverlock/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/overlock-network","download_url":"https://codeload.github.com/overlock-network/overlock/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/overlock-network%2Foverlock/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28846733,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-28T15:15:36.453Z","status":"ssl_error","status_checked_at":"2026-01-28T15:15:13.020Z","response_time":57,"last_error":"SSL_read: 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":["crossplane","development","kubernetes","native","platform"],"created_at":"2025-08-16T12:01:20.268Z","updated_at":"2026-01-28T16:00:45.377Z","avatar_url":"https://github.com/overlock-network.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Discord](https://img.shields.io/badge/discord-join-7289DA.svg?logo=discord\u0026longCache=true\u0026style=flat)](https://discord.gg/W7AsrUb5GC)\n[![Go Version](https://img.shields.io/badge/Go-1.24.0+-00ADD8?logo=go)](https://golang.org/doc/install)\n[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)\n[![GitHub Release](https://img.shields.io/github/v/release/overlock-network/overlock)](https://github.com/overlock-network/overlock/releases)\n\n\u003cp align=\"center\"\u003e\n  \u003cimg width=\"500\" src=\"https://raw.githubusercontent.com/overlock-network/overlock/refs/heads/main/docs/overlock_galaxy_text.png\"/\u003e\n\u003c/p\u003e\n\n# Overlock\n\n**Simplify Crossplane development and testing with a powerful CLI toolkit.**\n\nOverlock handles the complexity of setting up Crossplane environments, making it easy for developers to build, test, and deploy infrastructure-as-code solutions. Get a fully configured Crossplane environment running in minutes, not hours.\n\n## Table of Contents\n\n- [Features](#features)\n- [Quick Start](#quick-start)\n- [Installation](#installation)\n- [Documentation](#documentation)\n- [Architecture Overview](#architecture-overview)\n- [Ecosystem Comparison](#ecosystem-comparison)\n- [Community](#community)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Features\n\n- **⚡ Quick Environment Setup** - Create fully configured Crossplane environments with a single command\n- **🎯 Multi-Engine Support** - Works seamlessly with KinD, K3s, and K3d Kubernetes distributions\n- **📦 Package Management** - Install and manage Crossplane configurations, providers, and functions\n- **🔄 Live Development** - Hot-reload support for local package development\n- **🏗️ Registry Integration** - Support for both local and remote package registries\n- **🔌 Plugin System** - Extensible architecture for custom functionality\n\n## Quick Start\n\n```bash\n# Create a new Crossplane environment\noverlock environment create my-dev-env\n\n# Install a cloud provider (GCP example)\noverlock provider install xpkg.upbound.io/crossplane-contrib/provider-gcp:v0.22.0\n\n# Apply a configuration\noverlock configuration apply xpkg.upbound.io/devops-toolkit/dot-application:v3.0.31\n\n# List your environments\noverlock environment list\n```\n\nThat's it! You now have a fully functional Crossplane environment ready for development.\n\n## Installation\n\n### Prerequisites\n\n- **Docker** (required for creating Kubernetes clusters)\n- One of: **KinD**, **K3s**, or **K3d** (choose based on your preference)\n\n### Install Overlock\n\n**Latest version:**\n```bash\ncurl -sL \"https://raw.githubusercontent.com/overlock-network/overlock/refs/heads/main/scripts/install.sh\" | sh\nsudo mv overlock /usr/local/bin/\n```\n\n**Specific version:**\n```bash\ncurl -sL \"https://raw.githubusercontent.com/overlock-network/overlock/refs/heads/main/scripts/install.sh\" | sh -s -- -v 0.11.0-beta.11\nsudo mv overlock /usr/local/bin/\n```\n\n**Verify installation:**\n```bash\noverlock --version\n```\n\n### Building from Source\n\n```bash\ngit clone https://github.com/overlock-network/overlock.git\ncd overlock\ngo build -o overlock ./cmd/overlock\n```\n\nSee the [Development Guide](docs/development.md) for detailed build instructions.\n\n## Documentation\n\n### User Guides\n\n- **[Command Reference](docs/commands.md)** - Complete CLI command documentation\n- **[Configuration Guide](docs/configuration.md)** - Environment variables and configuration options\n- **[Usage Examples](docs/examples.md)** - Common workflows and practical examples\n- **[Troubleshooting](docs/troubleshooting.md)** - Solutions to common issues\n\n### Developer Resources\n\n- **[Development Guide](docs/development.md)** - Building from source, testing, and contributing\n- **[CONTRIBUTING.md](CONTRIBUTING.md)** - Contribution guidelines and code of conduct\n\n### Command Overview\n\nOverlock organizes functionality into intuitive command groups:\n\n| Command | Alias | Description |\n|---------|-------|-------------|\n| `environment` | `env` | Create and manage Kubernetes environments |\n| `provider` | `prv` | Install and manage cloud providers |\n| `configuration` | `cfg` | Manage Crossplane configurations |\n| `function` | `fnc` | Manage Crossplane functions |\n| `registry` | `reg` | Configure package registries |\n| `resource` | `res` | Create and manage custom resources |\n\nUse `overlock \u003ccommand\u003e --help` for detailed information on any command.\n\n## Architecture Overview\n\nOverlock is built with a modular architecture designed for extensibility and maintainability:\n\n```\n┌─────────────────────────────────────────────────────┐\n│                  Overlock CLI                       │\n├─────────────────────────────────────────────────────┤\n│  Environment Manager  │  Package Manager            │\n│  - KinD               │  - Configurations           │\n│  - K3s                │  - Providers                │\n│  - K3d                │  - Functions                │\n├─────────────────────────────────────────────────────┤\n│  Engine Manager       │  Registry Manager           │\n│  - Crossplane Install │  - Local Registries         │\n│  - Helm Integration   │  - Remote Registries        │\n├─────────────────────────────────────────────────────┤\n│  Resource Manager     │  Plugin System              │\n│  - Custom Resources   │  - Dynamic Loading          │\n│  - YAML Processing    │  - Extensibility            │\n└─────────────────────────────────────────────────────┘\n                          │\n                          ▼\n        ┌─────────────────────────────────┐\n        │    Kubernetes Cluster           │\n        │  (KinD / K3s / K3d)             │\n        │    + Crossplane                 │\n        └─────────────────────────────────┘\n```\n\n### Key Components\n\n- **CLI Framework**: Kong-based command parsing with intuitive subcommands\n- **Engine Management**: Helm-based Crossplane installation and lifecycle\n- **Environment Management**: Multi-engine Kubernetes cluster operations\n- **Package Management**: Crossplane configurations, providers, and functions\n- **Plugin System**: Extensible architecture for custom functionality\n\nFor detailed architecture information, see the [Development Guide](docs/development.md).\n\n## Ecosystem Comparison\n\n| Feature | Overlock | kubectl + helm | Crossplane CLI | up CLI |\n|---------|----------|----------------|----------------|--------|\n| Environment creation | ✅ Single command | ❌ Manual setup | ❌ Manual setup | ✅ Automated |\n| Multi-engine support | ✅ KinD/K3s/K3d | ✅ Any K8s | ✅ Any K8s | ⚠️ Limited |\n| Package management | ✅ Built-in | ❌ Manual | ✅ Limited | ✅ Built-in |\n| Live reload dev | ✅ Yes | ❌ No | ❌ No | ⚠️ Partial |\n| Registry support | ✅ Local + Remote | ❌ Manual | ⚠️ Remote only | ✅ Yes |\n| Environment lifecycle | ✅ Full control | ❌ Manual | ❌ Manual | ⚠️ Limited |\n| Plugin system | ✅ Yes | N/A | ❌ No | ❌ No |\n\n**Why Overlock?**\n\nOverlock bridges the gap between simple kubectl/helm workflows and full-featured cloud platforms. It provides:\n- Faster setup than manual kubectl/helm configurations\n- More development-focused features than standard Crossplane CLI\n- Better local development experience than cloud-based solutions\n- Complete control over your development environment\n\n## Community\n\n### Get Help \u0026 Connect\n\n- **💬 Discord**: [Join our Discord](https://discord.gg/W7AsrUb5GC) for questions and community support\n- **🐛 Issues**: [Report bugs or request features](https://github.com/overlock-network/overlock/issues)\n- **📖 Discussions**: [Join discussions](https://github.com/overlock-network/overlock/discussions)\n\n### Contributing\n\nWe welcome contributions from the community! Whether you're fixing bugs, adding features, or improving documentation, your help is appreciated.\n\n- Read our [Contributing Guide](CONTRIBUTING.md) to get started\n- Check out [Good First Issues](https://github.com/overlock-network/overlock/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)\n- Review the [Development Guide](docs/development.md) for technical details\n\n### Code of Conduct\n\nWe are committed to providing a welcoming and inclusive experience. Please read our Code of Conduct in [CONTRIBUTING.md](CONTRIBUTING.md).\n\n## Credits\n\nOverlock is built on top of excellent open-source projects:\n- [Crossplane](https://crossplane.io/) - The cloud native control plane framework\n- [Kubernetes](https://kubernetes.io/) - Container orchestration platform\n- [Helm](https://helm.sh/) - The Kubernetes package manager\n- [KinD](https://kind.sigs.k8s.io/), [K3s](https://k3s.io/), [K3d](https://k3d.io/) - Kubernetes engines\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.\n\n---\n\n\u003cp align=\"center\"\u003e\n  Made with ❤️ by the Overlock community\n\u003c/p\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foverlock-network%2Foverlock","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foverlock-network%2Foverlock","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foverlock-network%2Foverlock/lists"}