vulcan
======

Documentation for the ``vulcan`` command and its subcommands.


.. raw:: html

    <!-- spacer -->

.. dropdown:: ``vulcan`` — Discover and download Vulcan build artifacts.
    :animate: fade-in
    :color: secondary
    :open:

    **Full Help:**

    .. code-block:: text

        Usage:  [OPTIONS] COMMAND [ARGS]...
        
          Discover and download Vulcan build artifacts.
        
        Options:
          --dev                           Use dev artifacts.
          --stg, --staging                Use staging artifacts.
          --prd, --prod                   Use production artifacts.
          --env [dev|stg|staging|prd|prod|production]
                                          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 Neat artifact package from TARGET.

    **Usage:**

    .. code-block:: bash

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


.. dropdown:: ``vulcan download`` — Download artifacts for REPO and branch or tag REF.
    :animate: fade-in
    :color: secondary
    :open:

    **Full Help:**

    .. code-block:: text

        Usage:  [OPTIONS] [REPO] [REF]
        
          Download artifacts for REPO and branch or tag REF.
        
        Options:
          --dev                           Use dev artifacts.
          --stg, --staging                Use staging artifacts.
          --prd, --prod                   Use production artifacts.
          --env [dev|stg|staging|prd|prod|production]
                                          Artifact environment. Overrides the parent
                                          --env.
          --base-url TEXT                 Override the artifact base URL. Overrides
                                          the parent --base-url.
          -o, --output DIRECTORY          Output directory.  [default: neat-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:**

    .. code-block:: bash

        Usage:  [OPTIONS] [REPO] [REF]


.. dropdown:: ``vulcan install`` — Install a Neat artifact package from TARGET.
    :animate: fade-in
    :color: secondary
    :open:

    **Full Help:**

    .. code-block:: text

        Usage:  [OPTIONS] TARGET
        
          Install a Neat artifact 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:
          --dev                           Use dev artifacts.
          --stg, --staging                Use staging artifacts.
          --prd, --prod                   Use production artifacts.
          --env [dev|stg|staging|prd|prod|production]
                                          Artifact environment. Overrides the parent
                                          --env.
          --base-url TEXT                 Override the artifact base URL. Overrides
                                          the parent --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:**

    .. code-block:: bash

        Usage:  [OPTIONS] TARGET


Options
-------

.. list-table::
   :widths: 30 70
   :header-rows: 1

   * - **Option**
     - **Description**
   * - ``--dev``
     - Use dev artifacts.
   * - ``--stg, --staging``
     - Use staging artifacts.
   * - ``--prd, --prod``
     - Use production artifacts.
   * - ``--env``
     - Artifact environment. Defaults to production.
   * - ``--base-url``
     - Override the artifact base URL.