Help Center/ Object Storage Service/ Node.js SDK Developer Guide (Ally Region)/ Getting Started (SDK for Node.js)/ Installing the SDK (SDK for Node.js)
Updated on 2026-01-16 GMT+08:00
View PDF
Share

Installing the SDK (SDK for Node.js)

(Recommended) Installing the SDK Using npm

  1. Run the npm -V command to check the npm version and ensure that the npm is installed.
  2. Run the npm install esdk-obs-nodejs command to start the installation.
  • On a Windows operating system, the message "Not internal or external command" is displayed when you run the npm command. In this case, add the npm installation directory (generally the installation directory of Node.js) to the Path environment variable.
  • You may need to restart the computer for the environment variables to take effect.
  • If you use npm to install dependencies and the network malfunctions, use proxies.

Installing the SDK with the Source Code

The following procedures use OBS Node.js SDK of the latest version as an example.

  1. Download the OBS Node.js SDK by referring to .
  2. Decompress the development package to obtain folder examples (code examples), folder lib (SDK source code), file package.json (dependency configuration file), and file README.txt (feature description file of SDK versions).
  3. On the command-line interface (CLI), go to the directory under which the SDK development package was decompressed, and run the npm install command to install dependency libraries. A node_modules folder will be generated.
  4. (Optional) In the Eclipse JavaScript project, import the source code: Open Eclipse JavaScript IDE and choose Import > Projects from Folder or Archive. For Import source, select the directory under which the SDK development package is decompressed.

After the installation, the directory structure is similar to the following:

├── examples

├── lib

├── node_modules

├── package.json

└── README.txt