spmx
Getting Started

Quick start

The whole workflow as one commented cheat sheet.

# 1. One-time setup: directories, shims, PATH
spmx setup

# 2. Check that APFS, Xcode, PATH order and the store are healthy
spmx doctor

# 3. Optional: hydrate every new worktree the moment it is created
spmx hooks enable --global

# 4. Use Git worktrees the way you always did
git worktree add ../app-feature
cd ../app-feature

# 5. Build. The shim hydrates SourcePackages first, harvests new packages after
flutter run            # Flutter + SwiftPM
xcodebuild -scheme App build   # native Xcode
swift build            # SwiftPM CLI

# Inspect what spmx knows about this project
spmx status

# See what the store holds and how much it saves
spmx store status

# Already have worktrees full of downloaded packages? Preview, then apply
spmx migrate ~/dev
spmx migrate ~/dev --apply

# Reclaim space from packages no worktree uses any more
spmx store prune --dry-run
spmx store prune

# Bypass spmx for one command
SPMX_DISABLE=1 flutter run

Where to go next

Maintained by LuisRibeirooLast updated Edit this page on GitHub

On this page