Crossmint CLI Setup Guide

Install and Configure the Crossmint CLI

1️⃣ Install Dependencies

pnpm install

2️⃣ Build the CLI

pnpm build

4️⃣ Set Up Global Bin Directory (First Time Only)

If this is your first time using pnpm global packages, set up the global bin directory:

pnpm setup

Then restart your shell or run:

source ~/.zshrc  # or ~/.bashrc for bash

5️⃣ Link the CLI Globally

pnpm link

6️⃣ Verify the CLI is Installed

crossmint --help

Development Mode (Auto-Reload)

To automatically rebuild and relink on changes:

pnpm dev

Troubleshooting Issues

Issue: zsh: command not found: crossmint

Fix: Ensure the CLI is linked globally:

Add the links (ignore error if not previously installed):

pnpm unlink 2>/dev/null || pnpm link

Then, verify it’s linked:

pnpm bin -g
ls -l $(pnpm bin -g)

Issue: ERR_PNPM_NO_GLOBAL_BIN_DIR - Unable to find the global bin directory

Fix: This may not have been needed with older pnpm versions, but is now required. Follow the instructions in step 4️⃣ above to set up the global bin directory.

Releasing

For releasing you will need to modify the package.json version. You can do this by running

pnpm version <patch|minor|major>

Then you'll have to commit the package change and include it in your PR.

For Running a Production Build

First build the js dist for pkg

pnpm build:pkg

Notice that this will break the pnpm linked bin, you can fix it by running later pnpm build.

Then run to create the binary:

pnpm exec pkg dist/bin/crossmint.js --targets node20-macos-arm64 --output build/cli

Then try the package by running:

./build/cli help