Skip to content

installation.mdx

Latest commit

 

History

History
46 lines (31 loc) · 813 Bytes

installation.mdx

File metadata and controls

46 lines (31 loc) · 813 Bytes
Raw
title Installation
description Installing the ObjectStack SDK and CLI.

Requirements

  • Node.js 18+
  • TypeScript 5+

Package Installation

The @objectstack/spec package contains the core Zod Definitions and Type Interfaces.

npm

npm install @objectstack/spec

pnpm

pnpm add @objectstack/spec

yarn

yarn add @objectstack/spec

CLI Installation (Optional)

The CLI tool helps scaffold new objects and validate existing metadata.

npm install -g @objectstack/cli

Versioning

The Protocol follows Semantic Versioning.

  • Major (1.x): Breaking changes to the Protocol (JSON Structure).
  • Minor (1.1.x): New Field Types or Configuration Options.
  • Patch (1.1.1): Bug fixes in Zod validation or Type inference.