Installation

Requirements

• Node.js ≥ 20
• TypeScript (recommended, but not required)

Install

npm

npm install edicts

yarn

yarn add edicts

pnpm

pnpm add edicts

Global install (recommended for CLI usage)

Install globally so edicts is available as a command everywhere:

npm install -g edicts

Or if you’re developing locally:

npm link

Create your first edicts file

The fastest way is with edicts init:

edicts init
# Created ./edicts.yaml

This creates a starter edicts.yaml in the current directory. You can also specify a custom path:

edicts init --path ./config/edicts.yaml

The generated file looks like this:

version: 1
config:
  maxEdicts: 200
  tokenBudget: 4000
  categories: []
edicts:
  - id: e_001
    text: "Replace this with your first edict"
    category: general
    confidence: verified
    source: manual
    ttl: durable
history: []

Edit the placeholder edict with your own ground truth, or add new ones with the CLI:

edicts add --text "v2.0 launches April 15" --category product --confidence verified

Verify

edicts list

You should see your edicts listed.

Using with OpenClaw

If you’re using OpenClaw, it’s two commands:

openclaw plugins install openclaw-plugin-edicts
openclaw gateway restart

That’s it. The plugin auto-creates edicts.yaml in your workspace on first run — no manual setup needed. Start adding edicts right away:

edicts add --text "v2.0 launches April 15" --category product --confidence verified

Every agent session will automatically receive your edicts as ground truth.

Next steps

Head to the Quick Start to add edicts programmatically and render them into your agent’s prompt.