Getting Started
Getting Started
Get Blocks running in your project in under 5 minutes.
Quick Path
Installation
Install the CLI and dependencies
Quick Start
Create your first blocks.yml and run validation
Configuration
Customize validators and block definitions
AI Configuration
Set up AI providers for semantic validation
Prerequisites
- Node.js 20+ - Required runtime
- pnpm, npm, or yarn - Package manager
- AI API key - OpenAI, Anthropic, or Google (for domain validation)
The 3-Step Setup
# 1. Install globally
npm install -g @blocksai/cli
# 2. Create blocks.yml in your project
blocks init
# 3. Run validation
blocks run --allWhat Happens Next
After running blocks run --all:
- Schema validation - Checks your blocks.yml syntax
- Shape validation - Verifies file structure
- Domain validation - AI analyzes semantic compliance
Results show pass/fail for each block with actionable feedback.