Skip to main content

​
Latest CLI version - npm

The Crossmint CLI is a command-line tool that allows you to interact with Crossmint directly from your terminal. It can be installed via Homebrew or any javascript package managers and works on macOS, Linux, and Windows.

​
Installation

To download and install Crossmint CLI, run the following command from your terminal: 
pnpm add -g @crossmint/cli

​
Verify installation

After installing, verify the CLI is available and check the installed version: 
crossmint --version

​
Update

To update to the latest version, re-run the install command for your package manager, or use the following: 
pnpm add -g @crossmint/cli@latest

​
Command Reference

The Crossmint CLI provides the following commands:
CommandDescription
crossmint login Login to Crossmint
crossmint logout Logout from Crossmint
crossmint whoami Show current user and environment
crossmint help List and explains all commands
crossmint keys create Create a new API Key
crossmint keys list [type]List all API Keys (optionally filter by type: server|client)
crossmint keys delete <key-id> Delete an API Key
crossmint keys edit <key-id> Edit the scopes of an API Key
crossmint projects createCreate a new project
crossmint projects selectSelect a project
crossmint projects detailsShow project details
Refer to the individual command documentation for more detailed information on each command.