cli

command module

v0.1.0 Latest Latest Go to latest Published: Mar 2, 2026 License: Apache-2.0 Imports: 1 Imported by: 0

README ¶

OCM CLI

A new Command-line interface for the Open Component Model.

⚠️ Work in Progress — Commands may change. For stable CLI, see ocm v1.

Installation

From Source

# Clone the repo
git clone https://github.com/open-component-model/open-component-model.git
cd open-component-model

# Build
task cli:build

# Binary is at cli/tmp/bin/ocm
./cli/tmp/bin/ocm version

Quick Start

# Check version
ocm version

# Get a component version from an OCI registry
ocm get cv ghcr.io/my-org/ocm//my-component:1.0.0

Command Reference

Full command documentation: docs/reference/ocm.md

Shell Completion

# Bash
ocm completion

Plugins

The CLI supports plugins for additional repository types and capabilities.

# List available plugins
ocm plugin registry list

# Get plugin info
ocm plugin registry get <plugin-name>

See ADR-0001: Plugins for architecture details.

Documentation ¶

There is no documentation for this package.

Source Files ¶

View all Source files

main.go

Directories ¶

Path	Synopsis
cmd
add
add/component-version
configuration
describe
describe/types
download
download/plugin
download/resource
download/shared
generate
generate/docs
get
get/component-version
internal/cmd
internal/test Package test provides utilities for testing the OCM CLI commands.	Package test provides utilities for testing the OCM CLI commands.
plugins
plugins/get
plugins/list
setup
setup/hooks
sign
sign/component-version
transfer
transfer/component-version
transfer/component-version/internal
verify
verify/component-version
version
internal
context
flags/enum
flags/file
flags/log Package log provides logging functionality for the Open Component Model CLI.	Package log provides logging functionality for the Open Component Model CLI.
plugin/builtin
plugin/builtin/credentials/oci
plugin/builtin/input/dir
plugin/builtin/input/file
plugin/builtin/input/helm
plugin/builtin/input/utf8
plugin/builtin/location
plugin/builtin/oci
plugin/builtin/rsa
plugin/spec/config/v2alpha1
reference/compref Package compref provides functionality to parse component references used in OCM (Open Component Model).	Package compref provides functionality to parse component references used in OCM (Open Component Model).
render
render/graph
render/graph/list
render/graph/tree Package tree provides functionality to render tree structures	Package tree provides functionality to render tree structures
render/progress Package progress provides a generic progress tracking system for long-running operations.	Package progress provides a generic progress tracking system for long-running operations.
render/progress/bar Package bar provides a terminal progress bar visualizer.	Package bar provides a terminal progress bar visualizer.
render/progress/simple
repository/ocm Package ocm contains the ComponentVersionRepository abstraction to enable the CLI to work with different OCM repository implementations.	Package ocm contains the ComponentVersionRepository abstraction to enable the CLI to work with different OCM repository implementations.
subsystem
sync
transformers

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL