Skip to main content

Operational Systems

Windows Instructions​

Follow these steps to set up Stream2Vault (S2V) on your Windows machine.

warning

IMPORTANT: Use PowerShell All s2v commands, such as s2v validate and s2v generate, must be run in PowerShell. They will not work correctly in the standard Windows Command Prompt (cmd.exe).

  1. Install uv (Python Package Installer and Resolver): Open PowerShell and run the following command to install uv:

    powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

    For more details, refer to the official uv installation guide.

  2. Restart Your Terminal/IDE: After installing uv, close and reopen your PowerShell terminal. If you are using an Integrated Development Environment (IDE) like VS Code, restart it as well to ensure it recognizes the new uv command.

  3. Verify uv Installation: In the new PowerShell terminal, type uv --version to confirm that uv is installed correctly.

  4. Install s2v-client: Use uv to install the Stream2Vault client:

    uv tool install s2v-client

  5. Update Shell Configuration (if prompted or necessary): uv might suggest updating your shell configuration to include its shims directory in your PATH. If so, run:

    uv tool update-shell

    You may need to restart your PowerShell session again for these changes to take effect.

  6. Verify s2v Installation: Test the S2V client installation by running:

    s2v version

    This command should display the installed version of the S2V client.

  7. Login to Stream2Vault:

    • Navigate to your cloned Stream2Vault project repository in PowerShell.
    • Run the login command, typically using a configuration file (e.g., conf/s2v_config.json if it exists in your project): 
      s2v login -c path/to/your/s2v_config.json
      (Adjust the path to s2v_config.json as per your project structure).
    • Follow the prompts to sign in with your Evident SSO credentials.

  8. Install make (Optional, but Recommended for Makefile usage): If your project uses Makefiles for build and deployment automation, you'll need to install make.

    • Manual Installation (e.g., GnuWin32): You can download make binaries from projects like GnuWin32. After downloading and extracting, you'll need to add the directory containing make.exe (e.g., C:\Program Files (x86)\GnuWin32\bin) to your system's PATH environment variable.

    • Using Chocolatey (Recommended):

      Install Chocolatey, for more details, refer to the official Chocolatey installation guide. If you have Chocolatey installed, open PowerShell as Administrator and run:

      choco install make

    • Using Scoop: Install Scoop, for more details, refer to the official Scoop installation guide. If you use Scoop, run:

      scoop install make

  9. Verify make Installation: Open a new PowerShell terminal and type:

    make --version

    This should display the version of make installed.

You should now have a functional Stream2Vault environment on your Windows machine.