Install the OCM CLI

The OCM CLI is the primary tool for creating, managing, and transferring component versions. This guide covers installation options for different platforms.

You’ll end up with#

• The OCM CLI installed and ready to use on your system
• The ability to run ocm commands from your terminal

Estimated time#

~5 minutes

Prerequisites#

• Build from Source method requires:
  • Git
  • Go (1.25+)

Install the OCM CLI#

git clone https://github.com/open-component-model/open-component-model.git
cd open-component-model
task cli:build   # builds to cli/tmp/bin/ocm
task cli:install # installs to /usr/local/bin (requires sudo)

curl -s https://ocm.software/install-cli.sh | sudo bash

Verify Installation#

After installing, verify the CLI is working:

ocm version

Expected output:

{"major":"0","minor":"1","patch":"0","gitVersion":"0.1.0","goVersion":"go1.26.0","compiler":"gc","platform":"darwin/arm64"}

Windows Support#

While the CLI is designed to handle Windows-specific conventions such as drive-letter paths (e.g., C:\path\to\archive) and backslash path separators, there is no dedicated Windows CI infrastructure in place to continuously validate these code paths.

What this means#

• Windows builds are cross-compiled and checked for compilation correctness.
• Windows-specific logic (such as path detection and normalization) might tested via simulated OS behavior on non-Windows runners.
• There is no runtime testing on actual Windows environments in CI.
• Bugs specific to Windows runtime behavior may go undetected until reported.

Reporting issues#

If you encounter a Windows-specific issue, please report it at github.com/open-component-model/open-component-model/issues.

CLI Reference#

For detailed command documentation, see the OCM CLI Reference.

Next Steps#

• Tutorial: Create component versions - Learn how to create and store component versions using the OCM CLI