M
Meshkit

Installation

Install Meshkit and set up Kubo for your Node.js project.

Requirements

  • Node.js 20 or later
  • npm, pnpm, or yarn
  • A running Kubo daemon, or install Kubo and put ipfs on your PATH if you want localNode: true

Install the SDK

npm install @ipfs-meshkit/meshkit
pnpm add @ipfs-meshkit/meshkit
yarn add @ipfs-meshkit/meshkit

The package ships both ESM and CommonJS builds with bundled TypeScript types. No separate @types package needed.

Install Kubo (optional)

If you want Meshkit to start a local daemon automatically (localNode: true), install Kubo and ensure ipfs is on your PATH.

Follow the official Kubo install guide for your OS, then verify:

ipfs version
# Kubo version: 0.x.x

If you already have a Kubo daemon running elsewhere (server, Docker), skip this step — just pass its RPC URL in nodes.

Add .ipfs to .gitignore

When using localNode: true, Meshkit stores the Kubo repo in ./.ipfs by default. Add it to your .gitignore:

.ipfs

Introduction

Meshkit is a Node.js SDK for Kubo (IPFS) — upload, retrieve, pin, and manage IPNS records with failover and local daemon support.

Quick start

Upload, pin, and retrieve your first file with Meshkit in under 5 minutes.

On this page

RequirementsInstall the SDKInstall Kubo (optional)Add .ipfs to .gitignore