Skip to main content

Command Reference

This document provides detailed information about all Overlock CLI commands.

Table of Contents​

Environment Management​

Create and manage Crossplane-enabled Kubernetes environments.

overlock environment create​

Create a new Crossplane environment.

overlock environment create <name> [options]

Options:

  • --engine: Kubernetes engine to use (kind, k3s, k3d, k3s-docker)
  • --crossplane-version: Specific Crossplane version to install
  • --cpu: CPU limit for k3s-docker containers (e.g., 2, 0.5, 50%)
  • Additional options available via overlock environment create --help

Example:

overlock environment create my-dev-env

overlock environment list​

List all available environments.

overlock environment list

overlock environment start​

Start a stopped environment.

overlock environment start <name>

overlock environment stop​

Stop a running environment without deleting it.

overlock environment stop <name>

overlock environment upgrade​

Upgrade an environment to the latest Crossplane version.

overlock environment upgrade <name>

overlock environment delete​

Delete an environment and all its resources.

overlock environment delete <name>

overlock environment node create​

Add a remote node to a k3s-docker environment via SSH.

overlock environment node create <name> [options]

Options:

  • --env: Target environment name
  • --host: Remote host IP address
  • --scopes: Node scopes (e.g., engine, workloads)
  • --user: SSH user (default: root)
  • --port: SSH port (default: 22)
  • --key: Path to SSH private key (default: ~/.ssh/id_rsa)
  • --cpu: CPU limit for the node container (e.g., 2, 0.5, 50%)

Example:

overlock env node create my-node --env my-env --host 192.168.1.100 --scopes engine

overlock environment node delete​

Remove a remote node from a k3s-docker environment.

overlock environment node delete <name> [options]

Options:

  • --env: Target environment name
  • --host: Remote host IP address

Example:

overlock env node delete my-node --env my-env --host 192.168.1.100

Provider Management​

Install and manage cloud providers (GCP, AWS, Azure, etc.).

overlock provider install​

Install a provider from a repository.

overlock provider install <provider-url>

Example:

overlock provider install xpkg.upbound.io/crossplane-contrib/provider-gcp:v0.22.0

overlock provider list​

List all installed providers.

overlock provider list

overlock provider load​

Load a provider from a local file.

overlock provider load <name>

overlock provider serve​

Serve a provider for development with live reload support.

overlock provider serve <path> <main-path>

Example:

overlock provider serve ./my-provider ./cmd/provider

overlock provider delete​

Remove an installed provider.

overlock provider delete <provider-url>

Configuration Management​

Manage Crossplane configurations that define infrastructure patterns.

overlock configuration apply​

Apply a configuration from URL.

overlock configuration apply <url>

Multiple configurations:

overlock configuration apply <url1>,<url2>,<url3>

Example:

overlock configuration apply xpkg.upbound.io/devops-toolkit/dot-application:v3.0.31

overlock configuration list​

List all applied configurations.

overlock configuration list

overlock configuration load​

Load a configuration from a local file.

overlock configuration load <name>

overlock configuration serve​

Serve a configuration for development with live reload support.

overlock configuration serve <path>

Example:

overlock configuration serve ./my-config-package

overlock configuration delete​

Delete a configuration.

overlock configuration delete <url>

Function Management​

Manage Crossplane functions for custom composition logic.

overlock function apply​

Apply a function from URL.

overlock function apply <url>

Multiple functions:

overlock function apply <url1>,<url2>

overlock function list​

List all applied functions.

overlock function list

overlock function load​

Load a function from a local file.

overlock function load <name>

overlock function serve​

Serve a function for development with live reload support.

overlock function serve <path>

overlock function delete​

Delete a function.

overlock function delete <url>

Registry Management​

Configure package registries for storing and distributing Crossplane packages.

overlock registry create​

Create a local or remote registry connection.

Local registry:

overlock registry create --local --default

Remote registry:

overlock registry create --registry-server=<url> \
                        --username=<user> \
                        --password=<pass> \
                        --email=<email>

overlock registry list​

List all configured registries.

overlock registry list

overlock registry delete​

Delete a registry configuration.

overlock registry delete

Resource Management​

Create and manage custom resources.

overlock resource create​

Create a custom resource definition.

overlock resource create <type>

overlock resource list​

List all custom resources.

overlock resource list

overlock resource apply​

Apply resources from a file.

overlock resource apply <file.yaml>

Command Aliases​

All commands support short aliases for faster typing:

Full CommandAlias
environmentenv
configurationcfg
providerprv
functionfnc
registryreg
resourceres

Example:

# These are equivalent
overlock environment list
overlock env list

# These are equivalent
overlock configuration apply <url>
overlock cfg apply <url>