UiPath Documentation
automation-suite
2024.10
false
UiPath logo, featuring letters U and I in white

uipathctl reference guide

Last updated Feb 24, 2026

uipathctl manifest apply

Description

Load the configuration found at PATH, and apply it to the cluster.

The command performs a diff between the current state of the cluster and the desired state, and applies the changes to the cluster.

When the --override flag is present, the list overrides the selection found in the input file. The flag is mutually exclusive with the --only flag. When the exclude_components key is present in the input file, the components found in the list are excluded from the installed components. This has the highest priority over all the other flags and it is not mutually exclusive with any of them.

uipathctl manifest apply PATH [flags]
uipathctl manifest apply PATH [flags]

Examples

# Apply the configuration found in input.json, using the versions found in versions.json
uipathctl manifest apply input.json/cluster_config.json --versions versions.json
        
# Apply the configuration and specify the kubeconfig file to use
uipathctl manifest apply input.json/cluster_config.json --kubeconfig cluster.kubeconfig --versions versions.json

# Simulate the apply command and print on stdout the result of the operation
uipathctl manifest apply --dry-run input.json/cluster_config.json --versions versions.json

# Apply the configuration but skip the components installed directly by helm
uipathctl manifest apply --skip-helm input.json/cluster_config.json --versions versions.json

# Apply the configuration overriding the initial list of components
uipathctl manifest apply --override automation_hub,orchestrator --versions versions.json
# Apply the configuration found in input.json, using the versions found in versions.json
uipathctl manifest apply input.json/cluster_config.json --versions versions.json
        
# Apply the configuration and specify the kubeconfig file to use
uipathctl manifest apply input.json/cluster_config.json --kubeconfig cluster.kubeconfig --versions versions.json

# Simulate the apply command and print on stdout the result of the operation
uipathctl manifest apply --dry-run input.json/cluster_config.json --versions versions.json

# Apply the configuration but skip the components installed directly by helm
uipathctl manifest apply --skip-helm input.json/cluster_config.json --versions versions.json

# Apply the configuration overriding the initial list of components
uipathctl manifest apply --override automation_hub,orchestrator --versions versions.json

Options

      --component-timeout duration   timeout for individual components to be ready (default 15m0s)
      --continue-on-error            if true, continue applying the manifest even if an error occurs
      --dry-run                      if true, just print the result of the command, without applying it
      --fail-on-version              if true, fail if the version of the component is not found in the versions file
  -h, --help                         help for apply
      --no-wait                      if true, return immediately after the ArgoCD applications are created
      --only strings                 optional exclusive list of components to apply, doesn't touch the dependent components
      --override strings             optional list to override the components enabled in input.json file
      --skip-helm                    if true, skip components installed directly by helm
      --skip-oss-prereq              if true, skip OSS components prerequisites checks
      --versions string              path to versions file
      --component-timeout duration   timeout for individual components to be ready (default 15m0s)
      --continue-on-error            if true, continue applying the manifest even if an error occurs
      --dry-run                      if true, just print the result of the command, without applying it
      --fail-on-version              if true, fail if the version of the component is not found in the versions file
  -h, --help                         help for apply
      --no-wait                      if true, return immediately after the ArgoCD applications are created
      --only strings                 optional exclusive list of components to apply, doesn't touch the dependent components
      --override strings             optional list to override the components enabled in input.json file
      --skip-helm                    if true, skip components installed directly by helm
      --skip-oss-prereq              if true, skip OSS components prerequisites checks
      --versions string              path to versions file

Options inherited from parent commands

      --context string      name of the kubeconfig context to use
  -f, --force               override all user prompts to true
      --kubeconfig string   kubectl configuration file (default: ~/.kube/config)
      --log-format string   log format. one of [text,json] (default "text")
      --log-level string    set log level. one of [trace,debug,info,error] (default "error")
  -q, --quiet               suppress all output except for errors and warnings
      --timeout duration    timeout of the command (default 5h0m0s)
      --context string      name of the kubeconfig context to use
  -f, --force               override all user prompts to true
      --kubeconfig string   kubectl configuration file (default: ~/.kube/config)
      --log-format string   log format. one of [text,json] (default "text")
      --log-level string    set log level. one of [trace,debug,info,error] (default "error")
  -q, --quiet               suppress all output except for errors and warnings
      --timeout duration    timeout of the command (default 5h0m0s)
  • Description
  • Examples
  • Options
  • Options inherited from parent commands

Was this page helpful?

Connect

Need help? Support

Want to learn? UiPath Academy

Have questions? UiPath Forum

Stay updated