Install Serverless Devs and Docker

Install Serverless Devs

1. Install Serverless Devs by using one of the following methods:

   • Use a package manager

     • Use npm This method applies to Windows, macOS, and Linux operating systems for which npm is installed.

       Run the following command to install Serverless Devs:

       sudo npm install @serverless-devs/s -g

       Note

       If you use this method to install Serverless Devs, the version of Node.js must be Node.js 10 or later. After Node.js is installed, you can run the node --version command to view the version of Node.js.

     • Use Yarn This method applies to Windows, macOS, and Linux operating systems for which Yarn is installed.

       Run the following command to install Serverless Devs:

       sudo yarn global add @serverless-devs/s

   • Use a script This method is applicable to macOS and Linux.

     Run the following command to install Serverless Devs:

     curl -o- -L http://cli.serverless-devs.com/install.sh | bash

     After the installation is complete, you must configure the environment variables as prompted. Otherwise, the installation cannot take effect in a timely manner. For more information about the message routing feature, see FAQ.

2. Run the following command to check whether Serverless Devs is installed:

   s -v

   The following sample code is returned if Serverless Devs is successfully installed.

   @serverless-devs/s: 2.0.83, linux-x64, node-v14.17.4

Install Docker

You may want to use the FC component of Serverless Devs to build functions or debug functions on your on-premises machine by running the s build or s local command. In this case, Docker is required. After Docker is installed, Serverless Devs automatically creates a Docker container and performs debugging when Docker is required.

• Windows

  Download Docker by referring to the Docker documentation. If you experience a network problem, you can download Docker for Windows provided by Alibaba Cloud.

• macOS

  Download Docker by referring to the Docker documentation. If you experience a network problem, you can download Docker for macOS provided by Alibaba Cloud.

• Linux

  Download Docker by referring to the Docker documentation. If you experience a network problem, you can download Docker from Alibaba Cloud. For more information, see Alibaba Cloud image origin of the Docker community edition.

FAQ

• How do I upgrade Serverless Devs of an earlier version?

  You can run the installation command again to upgrade Serverless Devs. For more information, see Install Serverless Devs.

• If the installation process takes a long time, you can use the following npm source to install Serverless Devs. Example command:

  npm --registry=https://registry.npmmirror.com install @serverless-devs/s -g

• If you check the version of Serverless Devs after you upgrade Serverless Devs and find that Serverless Devs is not installed, you can use one of the following methods for troubleshooting based on your business requirements:

  • Run the following command to configure environment variables:

    export PATH=$HOME/.s/node-v14.19.3-linux-x64/bin:$PATH

    Note

    The version number in node-v14.19.3 in this command is an example only. The version number may vary depending on the operating system.

  • Open a new terminal.

• After Serverless Devs is installed in Linux or macOS, an error may occur when you run a command provided by Serverless Devs. You can use one of the following methods as required for troubleshooting if the Command not found error message is returned:

  • If you used npm or the installation script to install Serverless Devs, run the following command:

    ln -s $(npm root -g)/@serverless-devs/s/bin/s /usr/local/bin/s

  • If you used Yarn to install Serverless Devs, run the following command:

    ln -s $(yarn global dir)/node_modules/@serverless-devs/s /usr/local/bin/