Skip to main content

​
Installation

Install Shield using your preferred package manager: 
npm install @zeroleaks/shield

​
Requirements

Shield requires the following minimum versions:
  • Node.js 18+ or Bun 1.0+
  • TypeScript 5.0+ (optional, for type definitions)

​
Optional peer dependencies

Provider wrappers require the corresponding SDK as a peer dependency. Install only the ones you need:

​
OpenAI

npm install openai
Required for shieldOpenAI. Minimum version: openai >= 4.0.0

​
Anthropic

npm install @anthropic-ai/sdk
Required for shieldAnthropic. Minimum version: @anthropic-ai/sdk >= 0.20.0

​
Groq

npm install groq-sdk
Required for shieldGroq. Minimum version: groq-sdk >= 0.3.0

​
Vercel AI SDK

npm install ai
Required for shieldMiddleware and shieldLanguageModelMiddleware. Minimum version: ai >= 3.0.0
All peer dependencies are optional. You only need to install the SDKs for the providers you plan to use.

​
Verification

Verify your installation by importing the core functions: 
import { harden, detect, sanitize } from "@zeroleaks/shield";

console.log("Shield installed successfully!");
If using provider wrappers, verify the import: 
import { shieldOpenAI } from "@zeroleaks/shield/openai";
import { shieldAnthropic } from "@zeroleaks/shield/anthropic";
import { shieldGroq } from "@zeroleaks/shield/groq";
import { shieldMiddleware } from "@zeroleaks/shield/ai-sdk";

console.log("Provider wrappers imported successfully!");

​
Next steps

Quickstart

Learn how to use Shield in your application

Build docs developers (and LLMs) love

Get started for freeTalk to us