管理SDK版本

您可以通过Vega CLI（名为vega的命令行二进制程序）访问Vega SDK管理器。该工具简化了在开发项目中管理SDK版本的方式。您可以安装、切换版本，并与CI/CD管道无缝集成。它的工作原理类似于Node.js的nvm或Python的pyenv。

先决条件

在继续操作之前，请确认您已经安装了Vega CLI。

如果您有最新的Vega SDK（版本0.22+）： 该版本已经包含了Vega CLI。请前往开始使用或常见工作流程部分继续阅读。

如果Vega SDK版本是旧版本： 请按照Vega SDK安装说明进行操作，升级到最新版本。

开始使用

按照以下步骤验证安装是否成功，并创建首个项目配置。

1. 检查SDK管理器是否已经安装：

   复制代码 已复制到剪贴板。

   vega --version
   

   如果收到“command not found”错误，请按照先决条件中的步骤安装或升级Vega SDK。

2. 安装Vega SDK（如果需要）：

   如需安装最新的SDK版本

   复制代码 已复制到剪贴板。

   vega sdk install
   

   Vega虚拟设备安装：

   默认情况下，Vega SDK会安装Vega虚拟设备 (VVD)。VVD提供一个虚拟环境，以便测试和运行Vega应用。例如，在CI/CD环境中，您不需要虚拟设备。

   如果您想跳过Vega虚拟设备安装，请在运行安装命令之前设置环境变量SKIP_VVD_INSTALL=true：

   复制代码 已复制到剪贴板。

   export SKIP_VVD_INSTALL=true
   vega sdk install
   

   如需安装一个特定版本

   复制代码 已复制到剪贴板。

   vega sdk install 1.2.3
   

   如需查看可用版本

   复制代码 已复制到剪贴板。

   vega sdk list-remote
   

3. 验证安装是否成功：

   复制代码 已复制到剪贴板。

   vega sdk list-installed
   

4. 在项目根目录下创建一个vega-sdk-requirements.json文件：

   复制代码 已复制到剪贴板。

   {
      "vegaSdkVersion": "1.2.3"
   }
   

常见工作流程

这些示例说明如何在您的开发工作流程中使用SDK管理器。

设置一个新项目

按照此工作流程操作，为新的Vega项目配置开发环境。

1. 验证Vega CLI是否已安装：

   复制代码 已复制到剪贴板。

   vega --version
   

2. 安装相关SDK：

   复制代码 已复制到剪贴板。

   vega sdk install
   

3. 验证安装：

   复制代码 已复制到剪贴板。

   vega sdk list-installed
   

4. 执行运行状况检查：

   复制代码 已复制到剪贴板。

   vega sdk config doctor
   

   这将验证SDK安装是否正确、检查环境配置并识别潜在问题。

5. 创建项目需求文件（推荐）：

   复制代码 已复制到剪贴板。

   echo '{"vegaSdkVersion": "1.2.3"}' > vega-sdk-requirements.json
   

需求文件的工作原理

当您在包含vega-sdk-requirements.json的目录中运行任何Vega命令时，Vega会执行以下操作：

1. 在此文件中查找vegaSdkVersion字段。
2. 在执行该项目中的所有SDK操作时，都会使用vegaSdkVersion。
3. 覆盖所有全局默认版本设置。

示例项目结构

以下是一个具有版本要求的典型项目示例：

my-project/
├── vega-sdk-requirements.json
├── src/
└── README.md

vega-sdk-requirements.json文件包含：

{
  "vegaSdkVersion": "1.2.3"
}

管理多个项目

借助vega-sdk-requirements.json，每个项目都可以有自己的SDK版本：

# 项目A使用SDK 1.2.3
cd project-a
cat vega-sdk-requirements.json  # {"vegaSdkVersion": "1.2.3"}
vega sdk list-installed # 显示版本1.2.3处于活动状态
vega build

# 项目B使用SDK 2.0.0
cd ../project-b
cat vega-sdk-requirements.json  # {"vegaSdkVersion": "2.0.0"}
vega sdk list-installed # 显示版本2.0.0处于活动状态
vega build

更新SDK版本

让项目始终保持更新，获取最新SDK功能并及时修复错误。

快速更新

1. 查看可用版本：

   复制代码 已复制到剪贴板。

   vega sdk list-remote
   

2. 安装新版本：

   复制代码 已复制到剪贴板。

   vega sdk install 2.0.0
   

3. 设为默认值（可选）：

   复制代码 已复制到剪贴板。

   vega sdk use 2.0.0
   

4. （可选）清理旧版本：

   复制代码 已复制到剪贴板。

   vega sdk uninstall 1.2.3
   

安全更新（提交前请进行测试）

合并之前，在一个单独的分支中对新的SDK版本进行测试：

# 保留现有版本，单独安装新版本
vega sdk install 2.0.0

# 在单独的分支中进行测试
git checkout -b test-sdk-2.0.0
echo '{"vegaSdkVersion": "2.0.0"}' > vega-sdk-requirements.json
vega build

# 如果测试成功，则合并版本并通知团队
git checkout main
git merge test-sdk-2.0.0

链接现有的SDK安装

若您已在SDK管理器之外安装了Vega SDK，则可直接链接，无需重新安装。

# 通过KEPLER_SDK_PATH自动发现
vega sdk link --discover

# 或者通过特定路径链接
vega sdk link --path /path/to/existing/sdk

# 验证链接
vega sdk list-installed

CI/CD集成

对于像CI/CD管道这样的自动化环境，Vega提供了两种启用非交互模式的方法，以避免出现提示或需要交互的操作，从而确保自动化流程不会中断。

适用于自动化流程的非交互模式

方法1： CLI标记（推荐用于单条命令）

在命令中添加--non-interactive标记（如果支持）：

# 安装SDK时禁止提示
vega sdk install --non-interactive

# 把配置设置为非交互模式
vega sdk config setup --non-interactive --sdk-path /opt/vega-sdk

# 关联SDK时禁止提示
vega sdk link --discover --non-interactive

方法2： 环境变量（推荐用于整个管道）

将NONINTERACTIVE环境变量设置为true：

# 为整个会话设置环境变量
export NONINTERACTIVE=true

# 所有命令现在都以非交互模式运行
vega sdk install
vega sdk config setup
vega sdk link --discover

优先规则

当同时使用这两种方法时，系统会优先使用CLI标记：

1. CLI标记 (--non-interactive) - 最高优先级。
2. 环境变量 (NONINTERACTIVE=true) - 较低优先级。

借助这个规则，您可以使用环境变量设置默认行为，然后在需要时使用CLI标记覆盖默认行为。

高级功能

这些高级配置选项为特定的开发环境和工作流程提供了更高的灵活性。

自定义配置文件位置

默认情况下，Vega将其配置存储在~/vega/config.json中。您可以使用VEGA_CONFIG_FILE环境变量来指定配置文件位置。这在以下情形中很有用：

• 在同一台计算机上运行多个Vega配置
• 在团队中共享一个配置文件
• 不能使用默认路径的CI/CD环境
• 在不修改主设置的情况下，测试不同的配置

设置自定义配置路径

# 设置自定义配置文件位置
export VEGA_CONFIG_FILE="/path/to/custom/config.json"
  		  
# 然后运行设置命令或任何其他命令
vega sdk config setup
  		  
# 或者将相关操作组合为单个命令
export VEGA_CONFIG_FILE="/path/to/custom/config.json" && vega sdk config setup

将自定义配置路径设为永久路径

要永久使用自定义配置位置，请将导出内容添加到shell配置文件中：

# 如果是bash（~/.bashrc或~/.bash_profile）
echo 'export VEGA_CONFIG_FILE="/path/to/custom/config.json"' >> ~/.bashrc
  		  
# 如果是zsh (~/.zshrc)
echo 'export VEGA_CONFIG_FILE="/path/to/custom/config.json"' >> ~/.zshrc

CI/CD示例

# 为CI/CD管道设置自定义配置
export VEGA_CONFIG_FILE="/opt/ci/config.json"
export NONINTERACTIVE=true
  		  
# 设置和安装
vega sdk config setup --sdk-path /opt/vega-sdk
vega sdk install

最佳实践

遵循这些最佳实践，可以帮助您避免出现常见问题，并通过SDK管理器保持开发环境的稳定可靠。

1. 请务必使用需求文件。

   将vega-sdk-requirements.json提交到版本控制，确保整个团队的SDK版本保持一致。

2. 固定版本。

   为避免出现不兼容的更新，并确保每次构建结果一致，请使用确切的版本号。

   // 特定版本
   {"vegaSdkVersion": "1.2.3"}
   

3. 保持SDK管理器处于最新状态。

   新的SDK管理器版本包括软件改进、错误修复和对后继SDK版本的支持。

   复制代码 已复制到剪贴板。

   vega update
   

4. 在CI/CD中使用非交互模式。

   CI/CD管道无法为提示提供响应或完成确认操作。如果没有使用非交互模式，您的构建流程可能会无限期挂起，因为它会一直等待用户输入，而这些输入实际上不会发生。

   # 为整个管道设置环境变量
   export NONINTERACTIVE=true
   export SKIP_VVD_INSTALL=true
   
   # 在特定命令中使用标记
   vega sdk install --non-interactive 
   

命令参考

本节列出了所有SDK管理器命令及其描述。当您需要查看特定命令语法时，可以快速参考此内容。

基本命令

CI/CD命令

帮助命令

全局选项

故障排除

如果您遇到任何问题，请参阅SDK管理器问题故障排除。

相关主题

• 安装Vega SDK
• Vega SDK安装问题

Last updated: 2025年12月22日