OCM CLI on Open Component Model

ocm

Mon, 01 Jan 0001 00:00:00 +0000

ocm

The official Open Component Model (OCM) CLI

Synopsis

The Open Component Model command line client supports the work with OCM artifacts, like Component Archives, Common Transport Archive, Component Repositories, and Component Versions.

ocm add

Mon, 01 Jan 0001 00:00:00 +0000

ocm add

Add anything to OCM

ocm add {component-version|component-versions|cv|cvs} [flags]

Options

 -h, --help help for add

Options inherited from parent commands

 --config stringArray supply configuration by a given configuration file.
 By default (without specifying custom locations with this flag), the file will be read from one of the well known locations:
 1. The path specified in the OCM_CONFIG environment variable
 2. The XDG_CONFIG_HOME directory (if set), or the default XDG home ($HOME/.config), or the user's home directory
 - $XDG_CONFIG_HOME/ocm/config
 - $XDG_CONFIG_HOME/.ocmconfig
 - $HOME/.config/ocm/config
 - $HOME/.config/.ocmconfig
 - $HOME/.ocm/config
 - $HOME/.ocmconfig
 3. The current working directory:
 - $PWD/ocm/config
 - $PWD/.ocmconfig
 4. The directory of the current executable:
 - $EXE_DIR/ocm/config
 - $EXE_DIR/.ocmconfig
 If multiple configuration files are found, they will be merged in the order they are discovered.
 Using the option, the specified configuration file(s) will be used instead of the lookup above.
 --logformat enum set the log output format that is used to print individual logs
 json: Output logs in JSON format, suitable for machine processing
 text: Output logs in human-readable text format, suitable for console output
 (must be one of [json text]) (default text)
 --loglevel enum sets the logging level
 debug: Show all logs including detailed debugging information
 info: Show informational messages and above
 warn: Show warnings and errors only (default)
 error: Show errors only
 (must be one of [debug error info warn]) (default info)
 --logoutput enum set the log output destination
 stdout: Write logs to standard output
 stderr: Write logs to standard error, useful for separating logs from normal output
 (must be one of [stderr stdout]) (default stderr)
 --plugin-directory string default directory path for ocm plugins. (default "$HOME/.config/ocm/plugins")
 --plugin-shutdown-timeout duration Timeout for plugin shutdown. If a plugin does not shut down within this time, it is forcefully killed (default 10s)
 --temp-folder string Specify a custom temporary folder path for filesystem operations.
 --working-directory string Specify a custom working directory path to load resources from.

ocm add component-version

Mon, 01 Jan 0001 00:00:00 +0000

ocm add component-version

Add component version(s) to an OCM Repository based on a “component-constructor” file

Synopsis

Add component version(s) to an OCM repository that can be reused for transfers.

ocm completion

Mon, 01 Jan 0001 00:00:00 +0000

ocm completion

Generate the autocompletion script for the specified shell

Synopsis

Generate the autocompletion script for ocm for the specified shell. See each sub-command’s help for details on how to use the generated script.

ocm completion bash

Mon, 01 Jan 0001 00:00:00 +0000

ocm completion bash

Generate the autocompletion script for bash

Synopsis

Generate the autocompletion script for the bash shell.

This script depends on the ‘bash-completion’ package. If it is not installed already, you can install it via your OS’s package manager.

ocm completion fish

Mon, 01 Jan 0001 00:00:00 +0000

ocm completion fish

Generate the autocompletion script for fish

Synopsis

Generate the autocompletion script for the fish shell.

To load completions in your current shell session:

ocm completion powershell

Mon, 01 Jan 0001 00:00:00 +0000

ocm completion powershell

Generate the autocompletion script for powershell

Synopsis

Generate the autocompletion script for powershell.

To load completions in your current shell session:

ocm completion zsh

Mon, 01 Jan 0001 00:00:00 +0000

ocm completion zsh

Generate the autocompletion script for zsh

Synopsis

Generate the autocompletion script for the zsh shell.

If shell completion is not already enabled in your environment you will need to enable it. You can execute the following once:

ocm describe

Mon, 01 Jan 0001 00:00:00 +0000

ocm describe

Describe OCM entities or metadata

ocm describe [flags]

Options

 -h, --help help for describe

Options inherited from parent commands

 --config stringArray supply configuration by a given configuration file.
 By default (without specifying custom locations with this flag), the file will be read from one of the well known locations:
 1. The path specified in the OCM_CONFIG environment variable
 2. The XDG_CONFIG_HOME directory (if set), or the default XDG home ($HOME/.config), or the user's home directory
 - $XDG_CONFIG_HOME/ocm/config
 - $XDG_CONFIG_HOME/.ocmconfig
 - $HOME/.config/ocm/config
 - $HOME/.config/.ocmconfig
 - $HOME/.ocm/config
 - $HOME/.ocmconfig
 3. The current working directory:
 - $PWD/ocm/config
 - $PWD/.ocmconfig
 4. The directory of the current executable:
 - $EXE_DIR/ocm/config
 - $EXE_DIR/.ocmconfig
 If multiple configuration files are found, they will be merged in the order they are discovered.
 Using the option, the specified configuration file(s) will be used instead of the lookup above.
 --logformat enum set the log output format that is used to print individual logs
 json: Output logs in JSON format, suitable for machine processing
 text: Output logs in human-readable text format, suitable for console output
 (must be one of [json text]) (default text)
 --loglevel enum sets the logging level
 debug: Show all logs including detailed debugging information
 info: Show informational messages and above
 warn: Show warnings and errors only (default)
 error: Show errors only
 (must be one of [debug error info warn]) (default info)
 --logoutput enum set the log output destination
 stdout: Write logs to standard output
 stderr: Write logs to standard error, useful for separating logs from normal output
 (must be one of [stderr stdout]) (default stderr)
 --plugin-directory string default directory path for ocm plugins. (default "$HOME/.config/ocm/plugins")
 --plugin-shutdown-timeout duration Timeout for plugin shutdown. If a plugin does not shut down within this time, it is forcefully killed (default 10s)
 --temp-folder string Specify a custom temporary folder path for filesystem operations.
 --working-directory string Specify a custom working directory path to load resources from.

ocm describe types

Mon, 01 Jan 0001 00:00:00 +0000

ocm describe types

Describe OCM types and their configuration schema

Synopsis

Describe OCM types registered in various subsystems.

WHAT ARE SUBSYSTEMS? OCM uses a plugin-based architecture where different types of functionality are organized into subsystems. Each subsystem is a collection of related type implementations. When you use OCM commands or configure OCM resources, you specify types from these subsystems.

ocm download

Mon, 01 Jan 0001 00:00:00 +0000

ocm download

Download anything from OCM

ocm download {resource|resources|plugin|plugins} [flags]

Options

 -h, --help help for download

Options inherited from parent commands

 --config stringArray supply configuration by a given configuration file.
 By default (without specifying custom locations with this flag), the file will be read from one of the well known locations:
 1. The path specified in the OCM_CONFIG environment variable
 2. The XDG_CONFIG_HOME directory (if set), or the default XDG home ($HOME/.config), or the user's home directory
 - $XDG_CONFIG_HOME/ocm/config
 - $XDG_CONFIG_HOME/.ocmconfig
 - $HOME/.config/ocm/config
 - $HOME/.config/.ocmconfig
 - $HOME/.ocm/config
 - $HOME/.ocmconfig
 3. The current working directory:
 - $PWD/ocm/config
 - $PWD/.ocmconfig
 4. The directory of the current executable:
 - $EXE_DIR/ocm/config
 - $EXE_DIR/.ocmconfig
 If multiple configuration files are found, they will be merged in the order they are discovered.
 Using the option, the specified configuration file(s) will be used instead of the lookup above.
 --logformat enum set the log output format that is used to print individual logs
 json: Output logs in JSON format, suitable for machine processing
 text: Output logs in human-readable text format, suitable for console output
 (must be one of [json text]) (default text)
 --loglevel enum sets the logging level
 debug: Show all logs including detailed debugging information
 info: Show informational messages and above
 warn: Show warnings and errors only (default)
 error: Show errors only
 (must be one of [debug error info warn]) (default info)
 --logoutput enum set the log output destination
 stdout: Write logs to standard output
 stderr: Write logs to standard error, useful for separating logs from normal output
 (must be one of [stderr stdout]) (default stderr)
 --plugin-directory string default directory path for ocm plugins. (default "$HOME/.config/ocm/plugins")
 --plugin-shutdown-timeout duration Timeout for plugin shutdown. If a plugin does not shut down within this time, it is forcefully killed (default 10s)
 --temp-folder string Specify a custom temporary folder path for filesystem operations.
 --working-directory string Specify a custom working directory path to load resources from.

ocm download plugin

Mon, 01 Jan 0001 00:00:00 +0000

ocm download plugin

Download plugin binaries from a component version.

Synopsis

Download a plugin binary from a component version located in a component version.

ocm download resource

Mon, 01 Jan 0001 00:00:00 +0000

ocm download resource

Download resources described in a component version in an OCM Repository

Synopsis

Download a resource from a component version located in an Open Component Model (OCM) repository.

ocm generate

Mon, 01 Jan 0001 00:00:00 +0000

ocm generate

Generate documentation for the OCM CLI

Synopsis

A longer description that spans multiple lines and likely contains examples and usage of using your command. For example:

ocm generate docs

Mon, 01 Jan 0001 00:00:00 +0000

ocm generate docs

Generate Documentation for the CLI

Synopsis

Generate documentation for the OCM CLI in various formats, including Hugo-compatible markdown.

ocm get

Mon, 01 Jan 0001 00:00:00 +0000

ocm get

Get anything from OCM

ocm get {component-version|component-versions|cv|cvs|config|cfg} [flags]

Options

 -h, --help help for get

Options inherited from parent commands

 --config stringArray supply configuration by a given configuration file.
 By default (without specifying custom locations with this flag), the file will be read from one of the well known locations:
 1. The path specified in the OCM_CONFIG environment variable
 2. The XDG_CONFIG_HOME directory (if set), or the default XDG home ($HOME/.config), or the user's home directory
 - $XDG_CONFIG_HOME/ocm/config
 - $XDG_CONFIG_HOME/.ocmconfig
 - $HOME/.config/ocm/config
 - $HOME/.config/.ocmconfig
 - $HOME/.ocm/config
 - $HOME/.ocmconfig
 3. The current working directory:
 - $PWD/ocm/config
 - $PWD/.ocmconfig
 4. The directory of the current executable:
 - $EXE_DIR/ocm/config
 - $EXE_DIR/.ocmconfig
 If multiple configuration files are found, they will be merged in the order they are discovered.
 Using the option, the specified configuration file(s) will be used instead of the lookup above.
 --logformat enum set the log output format that is used to print individual logs
 json: Output logs in JSON format, suitable for machine processing
 text: Output logs in human-readable text format, suitable for console output
 (must be one of [json text]) (default text)
 --loglevel enum sets the logging level
 debug: Show all logs including detailed debugging information
 info: Show informational messages and above
 warn: Show warnings and errors only (default)
 error: Show errors only
 (must be one of [debug error info warn]) (default info)
 --logoutput enum set the log output destination
 stdout: Write logs to standard output
 stderr: Write logs to standard error, useful for separating logs from normal output
 (must be one of [stderr stdout]) (default stderr)
 --plugin-directory string default directory path for ocm plugins. (default "$HOME/.config/ocm/plugins")
 --plugin-shutdown-timeout duration Timeout for plugin shutdown. If a plugin does not shut down within this time, it is forcefully killed (default 10s)
 --temp-folder string Specify a custom temporary folder path for filesystem operations.
 --working-directory string Specify a custom working directory path to load resources from.

ocm get component-version

Mon, 01 Jan 0001 00:00:00 +0000

ocm get component-version

Get component version(s) from an OCM repository

Synopsis

Get component version(s) from an OCM repository.

The format of a component reference is: [type::]{repository}/[valid-prefix]/{component}[:version]

ocm get config

Mon, 01 Jan 0001 00:00:00 +0000

ocm get config

Display the effective merged OCM configuration

Synopsis

Evaluate the command line arguments and all explicitly or implicitly used configuration files and display the merged effective configuration as a single object.

ocm get types

Mon, 01 Jan 0001 00:00:00 +0000

ocm get types

Describe OCM types and their configuration schema

Synopsis

Describe OCM types registered in various subsystems.

ocm plugin

Mon, 01 Jan 0001 00:00:00 +0000

ocm plugin

Manage OCM plugins

ocm plugin [flags]

Options

 -h, --help help for plugin

Options inherited from parent commands

 --config stringArray supply configuration by a given configuration file.
 By default (without specifying custom locations with this flag), the file will be read from one of the well known locations:
 1. The path specified in the OCM_CONFIG environment variable
 2. The XDG_CONFIG_HOME directory (if set), or the default XDG home ($HOME/.config), or the user's home directory
 - $XDG_CONFIG_HOME/ocm/config
 - $XDG_CONFIG_HOME/.ocmconfig
 - $HOME/.config/ocm/config
 - $HOME/.config/.ocmconfig
 - $HOME/.ocm/config
 - $HOME/.ocmconfig
 3. The current working directory:
 - $PWD/ocm/config
 - $PWD/.ocmconfig
 4. The directory of the current executable:
 - $EXE_DIR/ocm/config
 - $EXE_DIR/.ocmconfig
 If multiple configuration files are found, they will be merged in the order they are discovered.
 Using the option, the specified configuration file(s) will be used instead of the lookup above.
 --logformat enum set the log output format that is used to print individual logs
 json: Output logs in JSON format, suitable for machine processing
 text: Output logs in human-readable text format, suitable for console output
 (must be one of [json text]) (default text)
 --loglevel enum sets the logging level
 debug: Show all logs including detailed debugging information
 info: Show informational messages and above
 warn: Show warnings and errors only (default)
 error: Show errors only
 (must be one of [debug error info warn]) (default info)
 --logoutput enum set the log output destination
 stdout: Write logs to standard output
 stderr: Write logs to standard error, useful for separating logs from normal output
 (must be one of [stderr stdout]) (default stderr)
 --plugin-directory string default directory path for ocm plugins. (default "$HOME/.config/ocm/plugins")
 --plugin-shutdown-timeout duration Timeout for plugin shutdown. If a plugin does not shut down within this time, it is forcefully killed (default 10s)
 --temp-folder string Specify a custom temporary folder path for filesystem operations.
 --working-directory string Specify a custom working directory path to load resources from.

OCM CLI on Open Component Model

ocm

ocm

Synopsis

ocm add

ocm add

Options

Options inherited from parent commands

SEE ALSO

ocm add component-version

ocm add component-version

Synopsis

ocm completion

ocm completion

Synopsis

ocm completion bash

ocm completion bash

Synopsis

ocm completion fish

ocm completion fish

Synopsis

ocm completion powershell

ocm completion powershell

Synopsis

ocm completion zsh

ocm completion zsh

Synopsis

ocm describe

ocm describe

Options

Options inherited from parent commands

SEE ALSO

ocm describe types

ocm describe types

Synopsis

ocm download

ocm download

Options

Options inherited from parent commands

SEE ALSO

ocm download plugin

ocm download plugin

Synopsis

ocm download resource

ocm download resource

Synopsis

ocm generate

ocm generate

Synopsis

ocm generate docs

ocm generate docs

Synopsis

ocm get

ocm get

Options

Options inherited from parent commands

SEE ALSO

ocm get component-version

ocm get component-version

Synopsis

ocm get config

ocm get config

Synopsis

ocm get types

ocm get types

Synopsis

ocm plugin

ocm plugin

Options

Options inherited from parent commands

SEE ALSO