> ## Documentation Index
> Fetch the complete documentation index at: https://docs.crossmint.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get started with the Crossmint CLI

> Manage and configure your Crossmint projects directly from the command line

export const ExternalLink = ({href}) => {
  return <a href={href} style={{
    borderBottom: 0
  }}>
            <svg className="dark:text-white text-black inline" width="20" height="21" viewBox="0 0 20 21" fill="none" xmlns="http://www.w3.org/2000/svg">
                <g opacity="0.32">
                    <path d="M5.83337 6.33325H14.1667M14.1667 6.33325V14.6666M14.1667 6.33325L5.83337 14.6666" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" />
                </g>
            </svg>
        </a>;
};

### Latest CLI version - <a href="https://www.npmjs.com/package/@crossmint/cli" target="_blank" style={{display: "inline-block", verticalAlign: "middle", textDecoration: "none", borderBottom: "none"}}><img src="https://img.shields.io/npm/v/@crossmint/cli" alt="npm" style={{display: "inline-block", verticalAlign: "middle", margin: 0}} noZoom /></a>

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:

<CodeGroup>
  ```bash pnpm theme={null}
  pnpm add -g @crossmint/cli
  ```

  ```bash yarn theme={null}
  yarn global add @crossmint/cli
  ```

  ```bash npm theme={null}
  npm install -g @crossmint/cli
  ```

  ```bash brew theme={null}
  brew tap crossmint/tap
  brew install crossmint
  ```
</CodeGroup>

### Verify installation

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

```bash theme={null}
crossmint --version
```

### Update

To update to the latest version, re-run the install command for your package manager, or use the following:

<CodeGroup>
  ```bash pnpm theme={null}
  pnpm add -g @crossmint/cli@latest
  ```

  ```bash yarn theme={null}
  yarn global add @crossmint/cli@latest
  ```

  ```bash npm theme={null}
  npm install -g @crossmint/cli@latest
  ```

  ```bash brew theme={null}
  brew upgrade crossmint
  ```
</CodeGroup>

## Command Reference

The Crossmint CLI provides the following commands:

| Command                                                                              | Description                                                   |
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------- |
| `crossmint login [options]` <ExternalLink href="/cli/login" />                       | Login to Crossmint                                            |
| `crossmint logout` <ExternalLink href="/cli/logout" />                               | Logout from Crossmint                                         |
| `crossmint whoami` <ExternalLink href="/cli/whoami" />                               | Show current user and environment                             |
| `crossmint help` <ExternalLink href="/cli/help" />                                   | List and explains all commands                                |
| `crossmint keys create` <ExternalLink href="/cli/keys/create" />                     | Create a new API Key                                          |
| `crossmint keys list [type]`<ExternalLink href="/cli/keys/list" />                   | List all API Keys (optionally filter by type: server\|client) |
| `crossmint keys delete <key-id>` <ExternalLink href="/cli/keys/delete" />            | Delete an API Key                                             |
| `crossmint keys edit <key-id>` <ExternalLink href="/cli/keys/edit" />                | Edit the scopes of an API Key                                 |
| `crossmint projects create`<ExternalLink href="/cli/projects/create" />              | Create a new project                                          |
| `crossmint projects select [project-id]`<ExternalLink href="/cli/projects/select" /> | Select a project                                              |
| `crossmint projects list`<ExternalLink href="/cli/projects/list" />                  | List all projects                                             |
| `crossmint projects details`<ExternalLink href="/cli/projects/details" />            | Show project details                                          |

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