Berican LabsBerican Labs
Back to Documentation
CLI & API

CLI Installation

Install the Berican CLI to deploy and manage your sites from the command line.

1Install via npm

Install the CLI globally using npm:

# Install globally
npm install -g @berican/cli

# Verify installation
berican --version

Requires Node.js 16 or later.

2Alternative Installation

Other installation methods:

# Using yarn
yarn global add @berican/cli

# Using pnpm
pnpm add -g @berican/cli

# Using npx (no install required)
npx @berican/cli deploy

3Authentication

Login to your Berican Labs account:

# Interactive login (opens browser)
berican login

# Login with API key
berican login --token YOUR_API_KEY

# Check login status
berican whoami

Your credentials are stored securely in ~/.berican/config.json.

4Quick Start

Deploy your first site:

# Navigate to your project
cd my-project

# Initialize (creates berican.json)
berican init

# Deploy
berican deploy

# Or deploy with a specific directory
berican deploy ./dist

5Update CLI

Keep the CLI up to date:

# Check for updates
berican update

# Or reinstall via npm
npm install -g @berican/cli@latest

The CLI will notify you when updates are available.