M
Meshkit

Introduction

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

Meshkit (@ipfs-meshkit/meshkit) gives Node.js apps a typed, batteries-included interface to Kubo — the reference IPFS implementation.

npm install @ipfs-meshkit/meshkit

What it does

FeatureDetail
StorageUpload bytes, retrieve by CID, pin content
Multi-node failoverPass multiple Kubo URLs; Meshkit tries each healthy node in order
Local daemonlocalNode: true — start or attach to Kubo automatically
IPNSPublish mutable pointers, resolve names, manage keys
MCP serverExpose all operations as AI-agent tools in Cursor, Claude Desktop, etc.

Quick example

import { init, setupGracefulShutdown } from '@ipfs-meshkit/meshkit';

const { meshkit, localNode } = await init({ localNode: true });
setupGracefulShutdown(localNode);

const cid = await meshkit.upload(new TextEncoder().encode('hello'));
await meshkit.pin(cid);

const bytes = await meshkit.retrieve(cid);
console.log(new TextDecoder().decode(bytes)); // hello

Requirements

  • Node.js 20+
  • A running Kubo daemon or set localNode: true (requires ipfs on PATH)

Packages

PackageDescription
@ipfs-meshkit/meshkitMain SDK — everything you need
@ipfs-meshkit/mcpMCP server for AI agent integration

On this page