vulcan

Documentation for the vulcan command and its subcommands.

vulcan — Discover and download Vulcan build artifacts.

Full Help:

Usage:  [OPTIONS] COMMAND [ARGS]...

  Discover and download Vulcan build artifacts.

Options:
  --env [dev|production|staging]  Artifact environment. Defaults to
                                  production.
  --base-url TEXT                 Override the artifact base URL.
  --help                          Show this message and exit.

Commands:
  download  Download artifacts for REPO and branch or tag REF.
  install   Install a Vulcan package from TARGET.

Usage:

Usage:  [OPTIONS] COMMAND [ARGS]...
vulcan download — Download artifacts for REPO and branch or tag REF.

Full Help:

Usage:  [OPTIONS] [REPO] [REF]

  Download artifacts for REPO and branch or tag REF.

Options:
  --env [dev|production|staging]  Artifact environment. Overrides `sima-cli
                                  vulcan --env`.
  --base-url TEXT                 Override the artifact base URL. Overrides
                                  `sima-cli vulcan --base-url`.
  -o, --output DIRECTORY          Output directory.  [default: vulcan-
                                  downloads]
  --artifact TEXT                 Artifact path glob to download from
                                  manifest.json. May be repeated.
  --json                          Print a machine-readable JSON summary.
  --help                          Show this message and exit.

Usage:

Usage:  [OPTIONS] [REPO] [REF]
vulcan install — Install a Vulcan package from TARGET.

Full Help:

Usage:  [OPTIONS] TARGET

  Install a Vulcan package from TARGET.

  TARGET supports REPO, REPO@branch, REPO@branch:spec, REPO@latest, or
  REPO@githash. If no branch or spec is provided, latest main is used.

Options:
  --env [dev|production|staging]  Artifact environment. Overrides `sima-cli
                                  vulcan --env`.
  --base-url TEXT                 Override the artifact base URL. Overrides
                                  `sima-cli vulcan --base-url`.
  -d, --install-dir DIRECTORY     Directory where package resources are
                                  downloaded and installed.  [default: .]
  -t, --type TEXT                 Install metadata variant
                                  metadata-<type>.json instead of
                                  metadata.json.
  -f, --force                     Force installation even if compatibility
                                  checks fail.
  --json                          Print resolved metadata URL and exit.
  --help                          Show this message and exit.

Usage:

Usage:  [OPTIONS] TARGET

Options

Option

Description

--env

Artifact environment. Defaults to production.

--base-url

Override the artifact base URL.