Installing and running CriProx
Desktop releases
Download the newest stable build from GitHub Releases.
| Platform | Release package | Support notes |
|---|---|---|
| macOS | Universal DMG | Runs on Apple Silicon and Intel Macs. The application is currently unsigned and not notarized. |
| Windows | x64 NSIS installer | The installer is currently unsigned and may trigger a SmartScreen warning. |
| Linux | x64 AppImage | CriProx can create project and export files, but Cricut Design Space is not available on Linux. |
Windows and Linux installers are built on their respective GitHub-hosted runners. Runtime behavior can still vary by distribution, graphics stack, printer driver, and security settings, so issue reports should include the CriProx version and operating-system details.
CriProx checks the repository for a newer stable release when the desktop app starts. The notice is informational: downloads and installation remain under your control, and automatic update installation is not configured.
Test installers from a branch
To share a feature build, push the branch to GitHub, then open Actions → Test installers → Run workflow. Leave GitHub's Branch dropdown on main so it runs the workflow stored there. Enter the feature branch name in the build_branch field (for example, feature/my-change) and start the run. The branch does not need its own copy of the workflow. The resolve job records the branch's exact commit, which all three platform jobs build.
After the run completes, open it and download the test-installer-macos, test-installer-windows, or test-installer-linux artifact from Artifacts. Extract the artifact ZIP to get the DMG, EXE, or AppImage, then share the run link with testers. Testers need to sign in to GitHub and have read access to the repository to download Actions artifacts. The workflow requests 30 days of artifact retention, subject to the repository's retention limit.
These builds use the branch's current application version and are for testing; they are not published as stable releases. Give testers the branch name from the run title and the commit from the Resolve branch commit job summary so they can identify the build when reporting an issue. The same unsigned-installer notes above apply.
Opening the unsigned macOS app
Only use a copy downloaded from the official CriProx repository. Move CriProx.app to Applications, then run:
xattr -dr com.apple.quarantine "/Applications/CriProx.app"
Open CriProx again after the command completes. This removes the quarantine attribute from that application bundle; it does not sign or notarize the app.
macOS release signing
The release workflow currently produces an unsigned macOS installer. Developer ID signing and notarization can be enabled after the repository has a Developer ID Application certificate and Apple notarization credentials configured as GitHub Actions secrets.
Local development
Prerequisites:
- Node.js 22 or newer
- npm
- Git
Clone and start the browser development server:
git clone https://github.com/Go2Engle/CriProx.git
cd CriProx
npm ci
npm run dev
Vite serves the app at http://127.0.0.1:5173 and reloads renderer changes during development.
Available commands
| Command | Purpose |
|---|---|
npm run dev |
Start the Vite browser preview on localhost |
npm run desktop |
Build the renderer and launch it in Electron |
npm test |
Run the Node test suite |
npm run build |
Type-check the project and build the production renderer |
npm run preview |
Serve the completed renderer build locally |
npm run package |
Build an installer for the current operating system |
npm run package:mac |
Build a universal macOS DMG |
npm run package:windows |
Build a Windows x64 NSIS installer |
npm run package:linux |
Build a Linux x64 AppImage |
npm run format |
Format source, tests, Electron files, and Vite configuration |
Installer output is written to release/. Windows and Linux packages should be built and tested on their target platforms; cross-building does not replace a native runtime check.
Network access and offline use
Scryfall and MPC Autofill searches require an internet connection, as does the desktop release check. Local artwork, locally saved projects, and cached export artwork can be used without a connection. Remote preview images are not guaranteed to remain available offline.
CriProx has no user account, hosted project service, or cloud sync. Browser-mode data is stored in the browser profile. Desktop mode keeps the active workspace and default managed-project library in the application's local profile, or uses the folder selected in Settings. On macOS, upgrades from v0.6.0 or earlier can copy the old Documents/CriProx library from Settings → Project library → Import old library. The old files remain in Documents as a backup. Export a JSON backup before clearing site/application data or switching environments.
Next step
Before printing, continue with the Cricut workflow and physical validation guide. For registered Cricut layouts, set up and save the cut template in Design Space once, capture its print output as a PDF, and import it into CriProx. For each deck, save the finished PDF from CriProx, print it from a dedicated PDF application at 100% / Actual size, then cut with the matching saved Design Space project using Already Printed / Skip printing when available. CriProx saves print files; it does not print directly or control the cutter. Manual cutting also uses a saved PDF printed from a PDF application, with paper-edge guides for trimming or a matched Basic Cut template for Cricut.
Published from the project’s Markdown documentation.
View source on GitHub ↗