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: 
npm install -g @trinsicventures/freezeray
Verify installation: 
freezeray --version
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: 
git clone https://github.com/TrinsicVentures/FreezeRay.git
cd FreezeRay
swift build -c release
cp .build/release/freezeray /usr/local/bin/

​
Homebrew (Coming Soon)

brew install trinsic/tap/freezeray

​
Initialize Your Project

Run init in your Xcode project directory: 
cd YourProject
freezeray init
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: 
dependencies: [
    .package(url: "https://github.com/TrinsicVentures/FreezeRay.git", from: "0.4.0")
]
Then add to your target: 
.target(
    name: "YourApp",
    dependencies: ["FreezeRay"]
)

​
Verify Installation

Check that everything is set up: 
# Verify CLI
freezeray --version

# Verify package was added
swift package show-dependencies | grep FreezeRay

# Verify directory structure
ls FreezeRay/

​
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
⌘I