管理 Amazon SAM CLI 版本 - Amazon Serverless Application Model
升级 Amazon SAM CLI卸载 Amazon SAM CLI从 Homebrew 切换管理 Amazon SAM CLI 每夜构建版本使用 pip 在虚拟环境中安装 Amazon SAM CLI使用 Homebrew 管理 Amazon SAM CLI故障排除
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅 中国的 Amazon Web Services 服务入门 (PDF)。

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

管理 Amazon SAM CLI 版本

通过升级、降级和卸载来管理您的 Amazon Serverless Application Model 命令行界面 (Amazon SAM CLI) 版本。或者，您可以下载并安装 Amazon SAM CLI 每夜构建版本。

升级 Amazon SAM CLI

要在 Linux 上升级 Amazon SAM CLI，请按照 安装 Amazon SAM CLI 中的安装说明进行操作，但要在安装命令中添加 --update 选项，如下所示：

sudo ./sam-installation/install --update

必须使用与安装相同的方法对 Amazon SAM CLI 进行升级。我们建议您使用软件包安装程序来安装和升级 Amazon SAM CLI。

要使用软件包安装程序升级 Amazon SAM CLI，请安装最新的软件包版本。有关说明，请参阅安装 Amazon SAM CLI。

要升级 Amazon SAM CLI，请再次重复 安装 Amazon SAM CLI 中的 Windows 安装步骤。

卸载 Amazon SAM CLI

要在 Linux 上卸载 Amazon SAM CLI，必须运行以下命令删除符号链接和安装目录：

  1. 找到符号链接和安装路径。

    • 使用 which 命令查找符号链接：

      which sam

      输出显示 Amazon SAM 二进制文件所在的路径，例如：

       /usr/local/bin/sam

    • 使用 ls 命令查找符号链接指向的目录：

      ls -l /usr/local/bin/sam

      在下面的示例中，安装目录为 /usr/local/aws-sam-cli。

       lrwxrwxrwx 1 ec2-user ec2-user 49 Oct 22 09:49 /usr/local/bin/sam -> /usr/local/aws-sam-cli/current/bin/sam

  2. 删除符号链接。

    sudo rm /usr/local/bin/sam

  3. 删除安装目录。

    sudo rm -rf /usr/local/aws-sam-cli

使用与安装相同的方法卸载 Amazon SAM CLI。我们建议您使用软件包安装程序来安装 Amazon SAM CLI。

如果您已使用软件包安装程序安装 Amazon SAM CLI，请按照以下步骤卸载。

要卸载 Amazon SAM CLI

  1. 通过修改并运行以下命令删除 Amazon SAM CLI 程序：

    $ sudo rm -rf /path-to/aws-sam-cli

    1. sudo – 如果您的用户对 Amazon SAM CLI 程序安装的位置具有写入权限，则 sudo 不是必需的。否则，sudo 是必需的。

    2. /path-to – Amazon SAM CLI 程序安装的路径。默认位置是 /usr/local。

  2. 通过修改并运行以下命令删除 Amazon SAM CLI $PATH：

    $ sudo rm -rf /path-to-symlink-directory/sam

    1. sudo – 如果您的用户具有 $PATH 写入权限，则无需 sudo。否则，sudo 是必需的。

    2. path-to-symlink-directory— 您的$PATH环境变量。默认位置是 /usr/local/bin。

  3. 通过运行以下命令验证 Amazon SAM CLI 是否已卸载：

    $ sam --version
command not found: sam

要使用 Windows 设置卸载 Amazon SAM CLI，请执行以下步骤：

  1. 从“开始”菜单中搜索“添加或删除程序”。

  2. 选择名为 Amazon SAM Command Line Interface 的结果，然后选择卸载以启动卸载程序。

  3. 确认您要卸载 Amazon SAM CLI。

从使用 Homebrew 切换到管理 Amazon SAM CLI

如果您使用 Homebrew 安装和升级 Amazon SAM CLI，我们建议使用 Amazon 支持的方法。按照以下说明切换到支持的方法。

要从使用 Homebrew 切换

  1. 按照 卸载 Homebrew 安装的 Amazon SAM CLI 中的说明卸载 Homebrew 托管版本。

  2. 按照 安装 Amazon SAM CLI 中的说明使用支持的方法安装 Amazon SAM CLI。

管理 Amazon SAM CLI 每夜构建版本

您可以下载并安装 Amazon SAM CLI 每夜构建版本。它包含 Amazon SAM CLI 代码的预发行版本，其稳定性可能不如生产版本。安装后，您可以通过与 sam-nightly 命令使用每夜构建版本。您可以同时安装和使用 Amazon SAM CLI 的生产版本和每夜构建版本。

注意

每夜构建版本不包含构建映像的预发行版本。因此，通过 --use-container 选项构建无服务器应用程序时，将使用构建映像的最新生产版本。

安装 Amazon SAM CLI 每夜构建版本

要安装 Amazon SAM CLI 每夜构建版本，请按照以下说明进行操作。

您可以使用软件包安装程序在 Linux x86_64 平台上安装 Amazon SAM CLI 的每夜构建版本。

要安装 Amazon SAM CLI 每夜构建版本

  1. 从aws-sam-cli GitHub存储库sam-cli-nightly中下载软件包安装程序。

  2. 按照安装 Amazon SAM CLI 的步骤安装每夜构建软件包。

您可以使用每夜构建软件包安装程序在 macOS 上安装 Amazon SAM CLI 每夜构建版本。

要安装 Amazon SAM CLI 每夜构建版本

  1. 从aws-sam-cli GitHub存储库中下载适用于您平台sam-cli-nightly的软件包安装程序。

  2. 按照安装 Amazon SAM CLI 的步骤安装每夜构建软件包。

Amazon SAM CLI 的每夜构建版本可通过以下下载链接获得：Amazon SAM CLI 每夜构建。要在 Windows 上安装每夜构建版本，请执行与在 安装 Amazon SAM CLI 中相同的步骤，但请改用每夜构建版本下载链接。

要验证您是否已安装每夜构建版本，请运行 sam-nightly --version 命令。此命令的输出形式为 1.X.Y.dev<YYYYMMDDHHmm>，例如：

SAM CLI, version 1.20.0.dev202103151200

从 Homebrew 切换到软件包安装程序

如果您正在使用 Homebrew 安装和升级 Amazon SAM CLI 每夜构建版本，并且想切换到使用软件包安装程序，请按照以下步骤操作。

要从 Homebrew 切换到软件包安装程序

  1. 卸载 Homebrew 安装的 Amazon SAM CLI 每夜构建版本。

    $ brew uninstall aws-sam-cli-nightly

  2. 通过运行以下命令，验证 Amazon SAM CLI 每夜构建版本是否已卸载：

    $ sam-nightly --version
zsh: command not found: sam-nightly

  3. 按照上一节中的步骤安装 Amazon SAM CLI 每夜构建版本。

使用 pip 在虚拟环境中安装 Amazon SAM CLI

我们建议使用本机软件包安装程序安装 Amazon SAM CLI。如果您必须使用 pip，我们建议您在虚拟环境中安装 Amazon SAM CLI。这样可确保干净的安装环境，并能在出现错误时提供隔离环境。

注意

自 2023 年 10 月 24 日起，Amazon SAM CLI 将停止对 Python 3.7 的支持。要了解更多信息，请参阅Amazon SAM CLI 停止支持 Python 3.7。

在虚拟环境中安装 Amazon SAM CLI

  1. 从您选择的起始目录，创建虚拟环境并命名。

    Linux / macOS
    $ mkdir project
$ cd project
$ python3 -m venv venv
    Windows
    > mkdir project
> cd project
> py -3 -m venv venv

  2. 激活虚拟环境

    Linux / macOS
    $ . venv/bin/activate

    提示符更改为向您显示虚拟环境处于活动状态。

    (venv) $
    Windows
    > venv\Scripts\activate

    提示符更改为向您显示虚拟环境处于活动状态。

    (venv) >

  3. 将 Amazon SAM CLI 安装到虚拟环境中。

    (venv) $ pip install --upgrade aws-sam-cli

  4. 验证 Amazon SAM CLI 是否已正确安装。

    (venv) $ sam --version
SAM CLI, version 1.94.0

  5. 您可以使用 deactivate 命令退出虚拟环境。不管何时启动新会话，都必须重新激活环境。

使用 Homebrew 管理 Amazon SAM CLI

注意

从 2023 年 9 月起，Amazon 将不再维护 Amazon SAM CLI (aws/tap/aws-sam-cli) 的 Amazon 托管 Homebrew 安装程序。要继续使用 Homebrew，您可以使用社区托管的安装程序 (aws-sam-cli)。从 2023 年 9 月起，任何引用 aws/tap/aws-sam-cli 的 Homebrew 命令都将重定向到 aws-sam-cli。

我们建议您使用我们支持的安装和升级方法。

使用 Homebrew 安装 Amazon SAM CLI

注意

这些说明使用社区托管的 Amazon SAM CLI Homebrew 安装程序。如需更多支持，请参阅 homebrew-core 存储库。

要安装 Amazon SAM CLI

  1. 运行以下命令：

    $ brew install aws-sam-cli

  2. 验证安装：

    $ sam --version

    成功安装 Amazon SAM CLI 后，您应该会看到类似下面的输出：

    SAM CLI, version 1.94.0

升级使用 Homebrew 的 Amazon SAM CLI

要升级使用 Homebrew 的 Amazon SAM CLI，请运行以下命令：

$ brew upgrade aws-sam-cli

卸载 Homebrew 安装的 Amazon SAM CLI

如果 Amazon SAM CLI 是使用 Homebrew 安装的，请按照以下步骤将其卸载。

要卸载 Amazon SAM CLI

  1. 运行以下命令：

    $ brew uninstall aws-sam-cli

  2. 通过运行以下命令验证 Amazon SAM CLI 是否已卸载：

    $ sam --version
command not found: sam

切换到社区托管的 Homebrew 安装程序

如果您正在使用 Amazon 托管 Homebrew 安装程序 (aws/tap/aws-sam-cli) 并希望继续使用 Homebrew，我们建议您切换到社区托管的 Homebrew 安装程序 (aws-sam-cli)。

要切换单个命令，请运行以下命令：

$ brew uninstall aws-sam-cli && brew untap aws/tap && brew cleanup aws/tap && brew update && brew install aws-sam-cli

按照这些说明单独运行每条命令。

要切换到社区托管的 Homebrew 安装程序

  1. 卸载 Amazon SAM CLI 的 Amazon 托管 Homebrew 版本：

    $ brew uninstall aws-sam-cli

  2. 验证 Amazon SAM CLI 是否已卸载：

    $ which sam
sam not found

  3. 移除 Amazon 托管 Amazon SAM CLI 点击：

    $ brew untap aws/tap

    如果您收到类似以下的错误，请添加 --force 选项并重试。

    Error: Refusing to untap aws/tap because it contains the following installed formulae or casks:
aws-sam-cli-nightly

  4. 移除 Amazon 托管安装程序的缓存文件：

    $ brew cleanup aws/tap

  5. 更新 Homebrew 和所有公式：

    $ brew update

  6. 安装 Amazon SAM CLI 的社区托管版本：

    $ brew install aws-sam-cli

  7. 验证 Amazon SAM CLI 是否已成功安装：

    $ sam --version
SAM CLI, version 1.94.0

故障排除

如果您在安装或使用 Amazon SAM CLI 时遇到错误，请参阅 Amazon SAM CLI 故障排除。