NOVA CLI reference 0.5.0 GitHub
  1. nova
  2. nova nucleus

nova nucleus cp

Copy files between local filesystem and Nucleus

Synopsis

Copy files or directories between the local filesystem and a Nucleus server, or within Nucleus.

Use the "n:" prefix to indicate a Nucleus path. Paths without the prefix are treated as local filesystem paths. Directories are copied recursively.

Supported directions: local -> Nucleus: nova nucleus cp ./file.usd n:/Projects/file.usd Nucleus -> local: nova nucleus cp n:/Projects/file.usd ./file.usd Nucleus -> Nucleus: nova nucleus cp n:/Projects/a.usd n:/Projects/b.usd

-o json prints source, destination and the copied files: "path" is the local file (absolute), "nucleus_path" the file on Nucleus, "size" its size in bytes. A copy within Nucleus lists only the destination.

nova nucleus cp <source> <destination> [flags]

Examples

  # Upload a local file to Nucleus
  nova nucleus cp ./Scene.usd n:/Projects/Scene.usd

  # Upload a directory recursively
  nova nucleus cp ./MyProject/ n:/Projects/MyProject/

  # Download a file from Nucleus
  nova nucleus cp n:/Projects/Scene.usd ./Scene.usd

  # Download a directory recursively, 4 files at a time
  nova nucleus cp -j 4 n:/Projects/MyProject/ ./MyProject/

  # Copy within Nucleus
  nova nucleus cp n:/Projects/a.usd n:/Projects/b.usd

  # Upload and create parent directories if needed
  nova nucleus cp -p ./Scene.usd n:/Projects/new/dir/Scene.usd

Options

  -h, --help            help for cp
  -o, --output format   Output format: text or json (default text)
  -j, --parallel int    Files to download at once (Nucleus -> local); small Nucleus deployments return 5xx when this is high (default 2)
  -p, --parents         Create parent directories on the destination if they don't exist
  -P, --progress        Show upload progress (percent, speed, ETA) on stderr

Options inherited from parent commands

      --debug                      Write diagnostic output to stderr: HTTP requests and responses, external commands, the resolved instance. Known secrets are redacted, but bodies (app environments, kubeconfigs) can still contain some: don't share the output unreviewed (env: NOVA_DEBUG=1)
      --env string                 (Wandelbots internal) Portal environment for this invocation: prod, stg or dev (default: the environment of the cloud instance, else of the last 'nova login'; env: NOVA_ENV)
      --insecure-skip-tls-verify   If true, the server's certificate will not be checked for validity (disables TLS verification for all requests)
      --instance string            Name of the instance to work against for this invocation (overrides the selected instance; env: NOVA_INSTANCE)
      --nucleus string             Name of the Nucleus server for this invocation (overrides the selected one; env: NOVA_NUCLEUS)
      --nucleus-host string        Nucleus server host (overrides config)
      --nucleus-tls                Use TLS (wss://) (default true)
      --nucleus-token string       Nucleus API token (overrides NUCLEUS_TOKEN env)

SEE ALSO

  • nova nucleus - EXPERIMENTAL: Interact with an Omniverse Nucleus server