Skip to content

ocm.md

Latest commit

 

History

History
79 lines (69 loc) · 4.8 KB

ocm.md

File metadata and controls

79 lines (69 loc) · 4.8 KB
title ocm
description The official Open Component Model (OCM) CLI.
suppressTitle true
toc true
sidebar
collapsed
true

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 [sub-command] [flags]

Options

      --config string                      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, this configuration file be used instead of the lookup above.
  -h, --help                               help for ocm
      --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.

SEE ALSO

  • [ocm add]({{< relref "ocm_add.md" >}}) - Add anything to OCM
  • [ocm completion]({{< relref "ocm_completion.md" >}}) - Generate the autocompletion script for the specified shell
  • [ocm describe]({{< relref "ocm_describe.md" >}}) - Describe OCM entities or metadata
  • [ocm download]({{< relref "ocm_download.md" >}}) - Download anything from OCM
  • [ocm generate]({{< relref "ocm_generate.md" >}}) - Generate documentation for the OCM CLI
  • [ocm get]({{< relref "ocm_get.md" >}}) - Get anything from OCM
  • [ocm plugin]({{< relref "ocm_plugin.md" >}}) - Manage OCM plugins
  • [ocm sign]({{< relref "ocm_sign.md" >}}) - create signatures for component versions in OCM
  • [ocm transfer]({{< relref "ocm_transfer.md" >}}) - Transfer anything in OCM
  • [ocm verify]({{< relref "ocm_verify.md" >}}) - verify digests and signatures of component versions in OCM
  • [ocm version]({{< relref "ocm_version.md" >}}) - Retrieve the build version of the OCM CLI