README
¶
The Crossplane CLI is a command-line tool for working with Crossplane, the cloud-native framework for platform engineering. It provides tools for building platforms on top of Crossplane and working with Crossplane clusters.
Crossplane is a Cloud Native Computing Foundation project.
License
Crossplane is under the Apache 2.0 license.
Directories
¶
| Path | Synopsis |
|---|---|
|
apis
|
|
|
dev/v1alpha1
Package v1alpha1 contains the Project API type.
|
Package v1alpha1 contains the Project API type. |
|
cmd
|
|
|
crossplane
command
Package main implements Crossplane's crank CLI - aka crossplane CLI.
|
Package main implements Crossplane's crank CLI - aka crossplane CLI. |
|
crossplane/cluster
Package cluster contains commands for inspecting a Crossplane cluster.
|
Package cluster contains commands for inspecting a Crossplane cluster. |
|
crossplane/common
Package common provides functions and helpers shared between CLI utilities, available for import by external tools interacting with Crossplane.
|
Package common provides functions and helpers shared between CLI utilities, available for import by external tools interacting with Crossplane. |
|
crossplane/common/crd
Package crd provides functions and helpers shared between CLI utilities, available for import by external tools interacting with Crossplane.
|
Package crd provides functions and helpers shared between CLI utilities, available for import by external tools interacting with Crossplane. |
|
crossplane/common/load
Package load provides functionality to load Kubernetes manifests from various sources
|
Package load provides functionality to load Kubernetes manifests from various sources |
|
crossplane/common/load/testutils
Package testutils is for test utilities.
|
Package testutils is for test utilities. |
|
crossplane/common/loggerwriter
Package loggerwriter provides an io.Writer implementation that writes to a crossplane logger.
|
Package loggerwriter provides an io.Writer implementation that writes to a crossplane logger. |
|
crossplane/common/resource
Package resource contains the definition of the Resource used by all trace printers, and the client used to get a Resource and its children.
|
Package resource contains the definition of the Resource used by all trace printers, and the client used to get a Resource and its children. |
|
crossplane/common/resource/xpkg
Package xpkg contains the client to get a Crossplane package with all its dependencies as a tree of Resource.
|
Package xpkg contains the client to get a Crossplane package with all its dependencies as a tree of Resource. |
|
crossplane/common/resource/xrm
Package xrm contains the client to get a Crossplane resource with all its children as a tree of Resource.
|
Package xrm contains the client to get a Crossplane resource with all its children as a tree of Resource. |
|
crossplane/completion
Package completion contains Crossplane CLI completions.
|
Package completion contains Crossplane CLI completions. |
|
crossplane/composition
Package composition contains commands for working with Crossplane Compositions.
|
Package composition contains commands for working with Crossplane Compositions. |
|
crossplane/config
Package config contains the `crossplane config` subcommands.
|
Package config contains the `crossplane config` subcommands. |
|
crossplane/convert
Package convert contains Crossplane CLI subcommands for migrating Crossplane resources to newer versions or kinds.
|
Package convert contains Crossplane CLI subcommands for migrating Crossplane resources to newer versions or kinds. |
|
crossplane/convert/compositionenvironment
Package compositionenvironment is a package for converting Pipeline Compositions using native Composition Environment capabilities to use function-environment-configs.
|
Package compositionenvironment is a package for converting Pipeline Compositions using native Composition Environment capabilities to use function-environment-configs. |
|
crossplane/convert/io
Package io is a package for reading and writing files for the migration command.
|
Package io is a package for reading and writing files for the migration command. |
|
crossplane/dependency
Package dependency contains commands for managing project dependencies.
|
Package dependency contains commands for managing project dependencies. |
|
crossplane/function
Package function contains commands for working with Functions.
|
Package function contains commands for working with Functions. |
|
crossplane/internal
Package internal contains internally used logic for Crossplane CLI.
|
Package internal contains internally used logic for Crossplane CLI. |
|
crossplane/operation
Package operation contains commands for working with Crossplane Operations.
|
Package operation contains commands for working with Crossplane Operations. |
|
crossplane/project
Package project contains commands for working with Crossplane projects.
|
Package project contains commands for working with Crossplane projects. |
|
crossplane/render
Package render implements helpers shared by the render subcommands (xr and op).
|
Package render implements helpers shared by the render subcommands (xr and op). |
|
crossplane/render/contextfn
Package contextfn implements an in-process composition function that the CLI hosts to inject and capture pipeline context for `crossplane render`.
|
Package contextfn implements an in-process composition function that the CLI hosts to inject and capture pipeline context for `crossplane render`. |
|
crossplane/render/op
Package op implements operation rendering using operation functions.
|
Package op implements operation rendering using operation functions. |
|
crossplane/render/xr
Package xr implements composite resource (XR) rendering.
|
Package xr implements composite resource (XR) rendering. |
|
crossplane/resource
Package resource contains commands for working with Crossplane resources.
|
Package resource contains commands for working with Crossplane resources. |
|
crossplane/top
Package top contains the top command.
|
Package top contains the top command. |
|
crossplane/trace
Package trace contains the trace command.
|
Package trace contains the trace command. |
|
crossplane/trace/internal/printer
Package printer contains the definition of the Printer interface and the implementation of all the available printers implementing it.
|
Package printer contains the definition of the Printer interface and the implementation of all the available printers implementing it. |
|
crossplane/validate
Package validate implements offline schema validation of Crossplane resources.
|
Package validate implements offline schema validation of Crossplane resources. |
|
crossplane/version
Package version contains version cmd
|
Package version contains version cmd |
|
crossplane/xpkg
Package xpkg contains Crossplane packaging commands.
|
Package xpkg contains Crossplane packaging commands. |
|
crossplane/xrd
Package xrd contains commands for working with CompositeResourceDefinitions.
|
Package xrd contains commands for working with CompositeResourceDefinitions. |
|
internal
|
|
|
async
Package async contains infrastructure for performing asynchronous tasks in the CLI.
|
Package async contains infrastructure for performing asynchronous tasks in the CLI. |
|
config
Package config implements loading the crossplane CLI config file.
|
Package config implements loading the crossplane CLI config file. |
|
crd
Package crd contains utilities for working with CRDs.
|
Package crd contains utilities for working with CRDs. |
|
dependency
Package dependency manages schema generation for Crossplane project dependencies.
|
Package dependency manages schema generation for Crossplane project dependencies. |
|
docker
Package docker contains helpers for working with Docker-compatible container runtimes.
|
Package docker contains helpers for working with Docker-compatible container runtimes. |
|
filesystem
Package filesystem contains utilities for working with filesystems.
|
Package filesystem contains utilities for working with filesystems. |
|
git
Package git contains functions to interact with repos.
|
Package git contains functions to interact with repos. |
|
kcl
Package kcl contains helpers for KCL function generation.
|
Package kcl contains helpers for KCL function generation. |
|
maturity
Package maturity implements maturity-level gating for kong commands.
|
Package maturity implements maturity-level gating for kong commands. |
|
project
Package project contains logic for building Crossplane projects.
|
Package project contains logic for building Crossplane projects. |
|
project/certs
Package certs generates certificates for the local dev registry.
|
Package certs generates certificates for the local dev registry. |
|
project/controlplane
Package controlplane manages local development control planes.
|
Package controlplane manages local development control planes. |
|
project/functions
Package functions contains functions for building embedded functions.
|
Package functions contains functions for building embedded functions. |
|
project/helm
Package helm implements a helm chart installer.
|
Package helm implements a helm chart installer. |
|
project/projectfile
Package projectfile reads and writes Crossplane project files.
|
Package projectfile reads and writes Crossplane project files. |
|
schemas/generator
Package generator generates language-specific schemas for Crossplane and Kubernetes resources.
|
Package generator generates language-specific schemas for Crossplane and Kubernetes resources. |
|
schemas/manager
Package manager implements a schema manager for use in Crossplane projects.
|
Package manager implements a schema manager for use in Crossplane projects. |
|
schemas/runner
Package runner contains functions for handling containers for schema generation.
|
Package runner contains functions for handling containers for schema generation. |
|
style
Package style contains the shared style for the Crossplane CLI.
|
Package style contains the shared style for the Crossplane CLI. |
|
terminal
Package terminal contains utilities for terminal interaction.
|
Package terminal contains utilities for terminal interaction. |
|
xpkg
Package xpkg contains CLI-specific functionality for working with Crossplane packages.
|
Package xpkg contains CLI-specific functionality for working with Crossplane packages. |
|
xrd
Package xrd contains utilities for working with CompositeResourceDefinitions.
|
Package xrd contains utilities for working with CompositeResourceDefinitions. |
|
proto
|
|
Click to show internal directories.
Click to hide internal directories.