Skip to main content

Installation

image

Installing the Primus Core SDK​

Welcome to the first step in integrating Primus Core SDK into your project! This guide will walk you through the installation process and help you get started quickly.

Prerequisites​

Before you begin, make sure you have:

  • Node.js（version 18 or later）installed on your system
  • npm (usually comes with Node.js) or yarn as your package manager

Installation Steps​

1. Install the SDK​

Open your terminal and navigate to your project directory. Then run one of the following commands:

  • Using npm:
npm install --save @primuslabs/zktls-core-sdk
  • Using yarn:
yarn add --save @primuslabs/zktls-core-sdk

This command will download and install the Primus Core SDK and its dependencies into your project.

2. Verify Installation​

To ensure the SDK was installed correctly, you can check your package.json file. You should see primuslabs/zktls-core-sdk listed in the dependencies section.

Importing the SDK​

After installation, you can import the SDK in your JavaScript or TypeScript files. Here's how:

const { PrimusCoreTLS } = require("@primuslabs/zktls-core-sdk");

Next Steps​

You can refer to the simple example to see an example about how to integrate Core SDK into your project.

If you need further support, feel free to reach out through our community on Discord.