Skip to main content

​
Installation

FreezeRay consists of two components: the CLI tool and the Swift package. The CLI’s init command handles adding the package for you.

​
Install CLI Tool

Install via npm:
Verify installation:
Apple Silicon only: The npm package contains a precompiled binary for Apple Silicon (ARM64) Macs. Intel Mac users must build from source.

​
Alternative: Build from Source

For Intel Macs or if you prefer to build from source:

​
Homebrew (Coming Soon)

​
Initialize Your Project

Run init in your Xcode project directory:
This will:
  1. Add FreezeRay package dependency to your Package.swift
  2. Create the FreezeRay/ directory structure
  3. Set up .gitignore rules (if needed)
The init command automatically adds the FreezeRay package to your project. No need to manually edit Package.swift!

​
Manual Package Installation (Alternative)

If you prefer to add the package manually:
Then add to your target:

​
Verify Installation

Check that everything is set up:

​
System Requirements

  • macOS 14.0+
  • Xcode 15.0+
  • Swift 5.9+
  • iOS Simulator (for freezing operations)

​
Next Steps

Follow the Quickstart

Freeze your first schema in 5 minutes