Are you an LLM? Read llms.txt for a summary of the docs, or llms-full.txt for the full context.
Skip to content

Installation

Install the CLI

Install Grimoire globally via npm, or run directly with npx (no install needed):

npm
npm i -g @grimoirelabs/cli

Verify Installation

Terminal
grimoire --help

You should see the list of available commands including compile, validate, simulate, and cast.

Initial Setup

Configure Grimoire for your target chain:

Terminal
grimoire setup

Runs an interactive onboarding wizard that configures your wallet, RPC endpoint, and validates adapter connectivity. Use --non-interactive with --chain and --rpc-url flags for CI environments.

Updating

Update to the latest version, or always use the latest with npx:

npm
npm i -g @grimoirelabs/cli@latest

Requirements

  • Node.js 18+
  • An RPC endpoint for the chain you want to target (Alchemy, Infura, or any standard JSON-RPC provider)
  • For onchain execution: a wallet with funds (see Running Spells for wallet setup)