The Landscaper CLI supports users to develop, maintain, and test components processed by the Landscaper. This comprises the handling of objects like component descriptors, blueprints, installations, etc.
Install the latest release via Nix, download binaries directly from GitHub Releases, or build and install directly from source.
Remark: This version of the Landscaper CLI requires that you have installed helm version 3.7 or higher due to some fundamental API changes especially with respect to the handling of helm charts stored as OCI resources.
Install using Nix (with Flakes)
# Nix (macOS, Linux, and Windows)
# ad hoc cmd execution
nix run github:openmcp-project/landscapercli -- --help
# install development version
nix profile install github:openmcp-project/landscapercli
# or release <version>
nix profile install github:openmcp-project/landscapercli/<version>
#check installation
nix profile list | grep landscapercli
# optionally, open a new shell and verify that cmd completion works
landscaper-cli --helpIf you install via GitHub releases, you need to
- download the correct binary artifact for your os and architecture
- unpack and put the
landscaperclibinary on your path
You can use this boilerplate:
# set operating system and architecture
os=darwin # choose between darwin, linux
arch=amd64 # choose between amd64
# Get latest version, unzip, make executable
curl -LO "https://github.com/openmcp-project/landscapercli/releases/latest/download/landscapercli-${os}-${arch}.gz"
gunzip landscapercli-${os}-${arch}.gz
chmod +x ./landscapercli-${os}-${arch}
# Move the binary in to your PATH
sudo mv ./landscapercli-${os}-${arch} /usr/local/bin/landscaper-cliInstructions can be found here.
Detailed descriptions for commands could be found here.
The command reference is located here.
The Landscaper CLI support the installation of the Docker OCI registry with the quickstart command.
A description how to access an OCI registry which requires authentication with the Landscaper CLI can be found here.
Other examples: https://github.com/openmcp-project/landscaper/blob/master/docs/tutorials/02-simple-import.md
This repository is a fork of https://github.com/gardener/landscapercli. The support for the Landscaper project is sunsetting in the Gardener organization. Maintainenance and development of the Landscaper project will continue in the https://github.com/openmcp-project/landscapercli repository. This doesn't affect any feature or functionality of the Landscaper project. OCI images and OCM components can be consumed directly from within this repository GitHub Container Registry.
This project is open to feature requests/suggestions, bug reports etc. via GitHub issues. Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our Contribution Guidelines.
If you find any bug that may be a security problem, please follow our instructions at in our security policy on how to report it. Please do not create GitHub issues for security-related doubts or problems.
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone. By participating in this project, you agree to abide by its Code of Conduct at all times.
Copyright OpenControlPlane contributors. Please see our LICENSE for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available via the REUSE tool.
OpenControlPlane is part of ApeiroRA, an EU Important Project of Common European Interest (IPCEI-CIS).
Copyright Linux Foundation Europe. For web site terms of use, trademark policy and other project policies please see https://linuxfoundation.eu/en/policies.