Amazon Developer

as

Settings
Sign out
Notifications
Alexa
Amazon Appstore
Ring
AWS
Documentation
Support
Contact Us
My Cases
Get Started
Design and Develop
Publish
Reference
Support
Skip to main content
The Vega SDK Manager helps you manage SDK versions for your development projects. You can install SDK versions, switch between versions, and integrate with CI/CD pipelines. Like version managers for other platforms (nvm for Node.js, pyenv for Python), it lets you maintain multiple SDK versions and switch between them for each project.

Where to access the Vega SDK Manager

You can install the Vega SDK Manager from:
  • Vega Studio extension: Installing the SDK Manager from Vega Studio extension From the Vega Studio panel, SDK Manager section, select Install SDK Manager. OR From the command palette, enter Vega: Install SDK Manager. See Set Up Vega Studio for more information.
  • Vega command-line interface (CLI): Follow the instructions on this page.

Prerequisites

Verify you have the Vega CLI before proceeding. If you have the latest Vega SDK (version 0.22+): You already have the Vega CLI. Proceed to Install the SDK from the CLI. If you have an older Vega SDK version: Upgrade to the latest version by following the Vega SDK installation instructions.

Install the SDK from the CLI

  1. Run this command to check if you have the Vega CLI:
  2. Install the Vega SDK (if needed): To install the latest SDK version
    To install a specific version
    To see available versions
  3. Verify your installation:

Create a project

  1. Install the SDK from the CLI if you haven’t already.
  2. Create a vega-sdk-requirements.json file in your project root:
  3. Run a health check to verify your environment:
    This verifies your SDK installation, checks environment configuration, and identifies potential issues.

How requirements files work

When you run any Vega command in a directory containing vega-sdk-requirements.json, Vega:
  1. Reads the vegaSdkVersion field in the file.
  2. Uses the vegaSdkVersion for all SDK operations in that project.
  3. Overrides any global default version settings.
Example project structure Here’s how a typical project with version requirements looks:

Manage multiple projects

Each project can have its own SDK version by using vega-sdk-requirements.json:

Update SDK version

Update your SDK to get the latest features and bug fixes.

Quick update

  1. Check available versions:
  2. Install new version:
  3. (Optional) Set the new version as your default:
  4. (Optional) Clean up old versions:

Safe update (test before committing)

Test new SDK versions in a separate branch before merging:
If you have a Vega SDK installed using the CLI installer or Vega Studio extension, you can link it instead of reinstalling. This saves time and disk space by reusing your existing installation.

CI/CD integration

For automated environments like CI/CD pipelines, Vega provides two methods to enable non-interactive mode. This prevents prompts or interactive behavior that would block automation.

Non-interactive mode for automation

Method 1: CLI flag (recommended for individual commands) Use the --non-interactive flag to prevent prompts on specific commands.
Method 2: Environment variable (recommended for entire pipeline) Set the NONINTERACTIVE environment variable when your entire pipeline should run without any user interaction. This is the preferred approach for CI/CD environments.

Precedence rules

When you use both methods, the CLI flag takes precedence:
  1. CLI flag (--non-interactive) - Highest priority.
  2. Environment variable (NONINTERACTIVE=true) - Lower priority.
  3. Default behavior (interactive mode) - Applies when you set neither option.
This lets you set a default behavior with the environment variable and override it with the CLI flag when needed.

Advanced features

These advanced configuration options provide additional flexibility for specialized development environments and workflows.

Custom configuration file location

By default, Vega stores its configuration in ~/vega/config.json. You can customize this location using the VEGA_CONFIG_FILE environment variable. This is useful for:
  • Running multiple Vega configurations on the same machine
  • Using a shared configuration file across a team
  • CI/CD environments where the default path isn’t suitable
  • Testing different configurations without affecting your main setup

Set custom configuration path

Make the custom configuration path persistent

To use a custom configuration location permanently, add the export to your shell profile:

CI/CD example

Command reference

This section lists all SDK Manager commands with their descriptions. Use this as a quick lookup when you need specific command syntax.

Basic commands

CI/CD commands

Help

Global options

Troubleshooting

If you encounter any issues, see Troubleshooting SDK Manager Issues.
Last modified on March 17, 2026