Installation

Getting ready for ObjectStack

Installation

Note: ObjectStack is currently in Private Beta. The packages described below will be available on the public npm registry upon the v1.0 launch in March 2026.

Pre-Requisites

ObjectStack is built on modern web standards. To run the full stack locally, you will need:

• Node.js: v18.0 or higher.
• Docker: (Optional) Required only if you want to run a local instance of MinIO or Redis for advanced features. By default, ObjectStack uses SQLite.

The CLI

The primary way to interact with ObjectStack is through the Command Line Interface.

# Designed for global installation
npm install -g @objectstack/cli

Once installed, you can verify the installation:

object --version

IDE Extensions

For the best experience, we recommend installing the official ObjectStack VS Code Extension (coming soon). This provides:

• Syntax highlighting for .objectql and .flow files.
• IntelliSense for schema references.
• Inline error checking.

System Requirements

ObjectStack's runtime is extremely lightweight.

• Memory: ~128MB RAM for a basic instance.
• Disk: ~50MB space.
• OS: macOS, Linux, or Windows (WSL2 recommended).