Installation

Prerequisites

Node.js >= 18.0.0
pnpm (recommended) or npm

SDK

Install the core SDK in your project:

pnpm add @policy-kit/sdk

npm install @policy-kit/sdk

yarn add @policy-kit/sdk

Peer Dependencies

The SDK has peer dependencies for Lit Protocol integration. If you plan to use off-chain (Tier 3) rules, install them as well:

pnpm add @lit-protocol/lit-node-client @lit-protocol/constants @lit-protocol/auth-helpers

Required Dependencies

The SDK requires viem for Ethereum interactions:

pnpm add viem

CLI

Install the CLI globally:

pnpm add -g @policy-kit/cli

npm install -g @policy-kit/cli

Verify the installation:

policykit --version

Smart Contracts

Install the Solidity contracts as a dependency for your own contracts:

forge install paladini-ai/policykit

npm install @policy-kit/contracts

pnpm add @policy-kit/contracts

Then import the contracts in your Solidity code:

import { IPolicyEngine } from "@policy-kit/contracts/src/core/IPolicyEngine.sol";
import { IRuleEvaluator } from "@policy-kit/contracts/src/rules/IRuleEvaluator.sol";

If using Foundry with the npm package, add a remapping to your remappings.txt:

@policy-kit/contracts/=node_modules/@policy-kit/contracts/

Local Development

If you’re developing or extending the smart contracts themselves, you’ll need Foundry:

curl -L https://foundry.paradigm.xyz | bash
foundryup

Then install contract dependencies:

cd contracts
forge install

Lit Actions

Install the Lit Actions package to get the pre-built policy evaluator bundle for off-chain rule evaluation:

pnpm add @policy-kit/lit-actions

npm install @policy-kit/lit-actions

The package includes:

Pre-built bundle at build/policyEvaluator.action.js — upload this to IPFS and pass the CID to the SDK’s LitClient
Source rules in src/rules/ — use as reference or starting points for custom rule implementations

Monorepo Setup (Contributing)

To work on PolicyKit itself:

git clone https://github.com/paladini-ai/policykit.git
cd policykit
pnpm install
pnpm build

Run tests across all packages:

pnpm test

Next Steps

Quickstart

Build and deploy your first policy.

Getting Started

Core Concepts

SDK Reference

CLI Reference

Smart Contracts

Examples

Installation

Installation

Prerequisites

SDK

Peer Dependencies

Required Dependencies

CLI

Smart Contracts

Local Development

Lit Actions

Monorepo Setup (Contributing)

Next Steps

Quickstart

​Installation

​Prerequisites

​SDK

​Peer Dependencies

​Required Dependencies

​CLI

​Smart Contracts

​Local Development

​Lit Actions

​Monorepo Setup (Contributing)

​Next Steps

Quickstart

Installation

Prerequisites

SDK

Peer Dependencies

Required Dependencies

CLI

Smart Contracts

Local Development

Lit Actions

Monorepo Setup (Contributing)

Next Steps