install

Documentation for the install command and its subcommands.

install — Install SiMa packages.

Full Help:

Usage:  [OPTIONS] [COMPONENT]

  Install SiMa packages.

  This command is the unified installer for all SiMa-defined packages—
  regardless of package type, platform, or deployment location. Packages
  follow the standard metadata specification (metadata.json), with optional
  extended formats such as metadata-v2.json.

  Key Features:

    • Automatically resolves the package URL, allowing simplified command
    syntax.

    • Handles all supported asset retrieval flows: Developer Portal
    authenticated downloads, Hugging Face artifacts, GitHub releases/assets,
    Docker Hub images, and raw file URLs.

    • Performs prerequisite checks (e.g., OS compatibility, disk space,
    platform model).

    • Supports interactive multi-selection when a package defines optional
    components.

    • Automatically prompts for authentication when required.

    • Works uniformly across all SiMa package types—including SDK releases,
    OptiView, LLiMa demos, 16-channel vision demos, and internal tools.

  Examples:
      sima-cli install hostdriver -v 1.6.0

      sima-cli install optiview

      sima-cli install -m https://custom-server/packages/foo/metadata.json

      sima-cli install samples/llima -v 1.7.0

Options:
  -v, --version TEXT              SDK version (required for SDK-dependent
                                  components unless --metadata is provided)
  -m, --mirror TEXT               URL to a metadata.json file for generic
                                  installation
  -t, --tag TEXT                  Tag of the package. With --vulcan, metadata
                                  variant type such as minimum.
  --vulcan                        Install from Vulcan artifacts using the
                                  Vulcan package resolver.
  --env [dev|production|staging]  Vulcan artifact environment. Used with
                                  --vulcan. Defaults to production.
  --base-url TEXT                 Override the Vulcan artifact base URL. Used
                                  with --vulcan.
  -d, --install-dir DIRECTORY     Directory where Vulcan package resources are
                                  downloaded and installed. Used with
                                  --vulcan.  [default: .]
  --json                          With --vulcan, print resolved metadata URL
                                  and exit.
  -f, --force                     Force installation even if compatibility
                                  checks fail.
  --help                          Show this message and exit.

Usage:

Usage:  [OPTIONS] [COMPONENT]

Options

Option	Description
-v, --version	SDK version (required for SDK-dependent components unless –metadata is provided)
-m, --mirror	URL to a metadata.json file for generic installation
-t, --tag	Tag of the package. With –vulcan, metadata variant type such as minimum.
--vulcan	Install from Vulcan artifacts using the Vulcan package resolver.
--env	Vulcan artifact environment. Used with –vulcan. Defaults to production.
--base-url	Override the Vulcan artifact base URL. Used with –vulcan.
-d, --install-dir	Directory where Vulcan package resources are downloaded and installed. Used with –vulcan. [default: .]
--json	With –vulcan, print resolved metadata URL and exit.
-f, --force	Force installation even if compatibility checks fail.