Clerk CLI

1.0.2 verified Thu Apr 23 auth: no javascript

The `clerk` package provides the command-line interface (CLI) for interacting with Clerk, an authentication and user management platform. It allows developers to manage Clerk applications, users, and various other resources directly from their terminal. The current stable version is v1.0.2, with frequent canary releases indicating active development and continuous integration of new features and fixes. While canary versions are released frequently, stable major versions typically follow a more structured cadence, ensuring stability. This CLI is an essential tool for automating tasks, scripting interactions, and managing Clerk resources without needing to access the Clerk Dashboard, differentiating it by offering direct programmatic control over the Clerk ecosystem. It requires Node.js version 20 or higher.

Common errors

error clerk: command not found ↓

cause The Clerk CLI package is not installed globally or is not in your system's PATH.

fix

Run npm install -g clerk to install it globally, or ensure you are using npx clerk if installed as a local dev dependency.

error Error: Not authenticated. Please run `clerk login` ↓

cause You are attempting to execute a command that requires authentication with your Clerk account, but you haven't logged in or your session has expired.

fix

Execute clerk login in your terminal and follow the instructions to authenticate via your web browser.

error Error: Required argument '--name' is missing ↓

cause You've invoked a command that requires a specific flag or argument, but it was not provided.

fix

Consult the command's help message (e.g., clerk apps create --help) to identify all required arguments and flags, then re-run the command with the missing information.

Warnings

gotcha The Clerk CLI requires Node.js version 20.0.0 or higher. Running with older versions may lead to unexpected errors or installation failures. ↓

fix Upgrade your Node.js environment to version 20.0.0 or later using a tool like nvm or by installing directly from the official Node.js website.

gotcha When automating CLI commands (e.g., in CI/CD pipelines), ensure your API keys or session tokens are managed securely. Avoid hardcoding sensitive credentials directly into scripts. ↓

fix Utilize environment variables (e.g., `CLERK_API_KEY`) or dedicated secret management systems provided by your CI/CD platform to inject credentials at runtime.

gotcha Using `npx clerk` for every command ensures you're running the version of the CLI associated with your project's `package.json`, but can be slower than a global install. A global install (`npm install -g clerk`) provides faster access but requires manual updates. ↓

fix Choose the installation method that best suits your workflow: global for frequent direct use, or `npx` for project-specific and version-controlled usage.

Install

npm install clerk

yarn add clerk

pnpm add clerk

Quickstart

This quickstart demonstrates how to install the Clerk CLI globally, authenticate with your Clerk account, and perform basic operations like listing and creating Clerk applications directly from the command line.

# Install the Clerk CLI globally
npm install -g clerk

# Log in to your Clerk account (this will open a browser window)
clerk login

# View your active Clerk applications
clerk apps list

# Create a new Clerk application with a specific name and instance type
clerk apps create --name "My New Frontend" --instance-type "development"

# Get details for a specific application
clerk apps show <your_app_id>