Get started with the Crossmint CLI

Manage and configure your Crossmint projects directly from the command line

The Crossmint CLI is a command-line tool that allows you to interact with Crossmint directly from your terminal. It uses homebrew and works on macOS and Linux.

Prerequisites

• You’ll need to have Hombrew installed.

Installing Crossmint CLI

To download and install Crossmint CLI, run the following command from your terminal:

brew tap crossmint/tap
brew install crossmint

To update Crossmint CLI run:

brew update
brew upgrade crossmint

Command Reference

The Crossmint CLI provides the following commands:

Command	Description
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 create	Create a new project
crossmint projects select	Select a project
crossmint projects details	Show project details

Refer to the individual command documentation for more detailed information on each command.