CLI Toolingv1.0.0 • Scaffolding Engine

CLI Reference.

The official glidecn-cli scaffolds transition pipelines, downloads transition recipes, and auto-wires Framer Motion into your project with zero runtime dependencies.

Initialization Quickstart

# Initialize GlideCN in your project directory

$pnpm dlx glidecn-cli init

1. Project Initialization (init)

glidecn-cli init executes an interactive setup wizard that detects your framework, installs peer dependencies (framer-motion, lucide-react), and creates the core motion barrel.

Interactive Prompts:

TypeScript or JavaScript
Framework Adapter (Next.js App / Next.js Pages / React Router)
Target directory (default: components/glidecn)
Default baseline transition (fade)

Interactive Setup Wizard

$pnpm dlx glidecn-cli init

Generated Project Structure

components/
└── glidecn/
    ├── index.ts                 # Barrel exports (GlideCN, Page, useGlide)
    ├── provider.tsx             # <GlideCNProvider>
    ├── adapters/
    │   └── next-app.tsx         # <GlideCN> Adapter
    ├── core/
    │   ├── animation-engine.ts  # Variant builders & GPU hints
    │   ├── registry.ts          # TransitionRegistry
    │   ├── types.ts             # Strict TypeScript types
    │   └── utils.ts             # Easing & Math utilities
    └── transitions/
        └── fade.ts              # Default baseline transition

2. Installing Transitions (add)

glidecn-cli add downloads individual transitions, batches, or entire family categories directly into components/glidecn/transitions and auto-updates the barrel registry.

All commands below support pnpm, npm, bun, and yarn.

Single Transition Installation

Single Transition

Install a specific transition by its name.

Single Transition

$pnpm dlx glidecn-cli add circular-portal

Multi-Transition Batch Installation

Multi-Transition

Install multiple transitions simultaneously separated by a space.

Batch Install

$pnpm dlx glidecn-cli add cube liquid-morph glitch page-curl slice-reveal

Category Bundle Installation (--category)

Family Category

Install all transitions belonging to a specific family (e.g. spatial, portal, flow).

Category Flag

$pnpm dlx glidecn-cli add --category spatial

Complete Catalog Installation (--all)

All 70 Transitions

Installs the entire transition suite into your project in one shot.

Full Suite

$pnpm dlx glidecn-cli add --all

3. Updating Existing Codebase (update)

glidecn-cli update auto-detects your existing installation, checks your project language and framework adapter, and refreshes all core engine files, adapters, and installed transitions with the latest improvements and bugfixes.

What gets updated:

Core engine (transition-manager, transition-context, etc.)
Framework adapters (adapters/next-app, etc.)
All currently installed transitions (or all 70 with --all)
Barrel exports (index.ts / index.js)

Interactive Project Update

Interactive

Refreshes your core engine and existing transitions with interactive confirmation.

Update Command

$pnpm dlx glidecn-cli update

Update & Upgrade to All 70 Transitions

--all Flag

Refreshes the core and installs the full suite of all 70 transitions.

Full Upgrade

$pnpm dlx glidecn-cli update --all

Automated / CI Update (--yes)

CI / Headless

Skips prompts for automated upgrade scripts and GitHub Actions workflows.

Non-interactive

$pnpm dlx glidecn-cli update --yes

4. Catalog Explorer (list)

glidecn-cli list inspects available transitions, prints family statistics, and prints terminal snippets.

Browse Catalog

# Print the full transition catalog

$pnpm dlx glidecn-cli list

5. Flags & Options Reference

Complete matrix of all command-line flags and arguments supported by glidecn-cli.

glidecn-cli Command Flags

--all, -a

boolean

Installs or updates all 70 page and physics transitions in the catalog in a single batch.

Default:false

--yes, -y

boolean

Skips interactive confirmation prompts (ideal for CI/CD and automated upgrade scripts).

Default:false

--category, -c <name>

string

Installs all transitions belonging to a specific family: flow, portal, paper, mask, spatial, dynamic, experimental, retro.

--path, -p <dir>

string

Specifies a custom destination directory for the generated components and transitions (ideal for monorepos).

Default:components/glidecn

--help, -h

boolean

Displays help information, usage instructions, and available flags for any command.

--version, -V

boolean

Prints the current installed version of the glidecn-cli package.

6. Monorepos & Custom Paths

Use the --path option to direct files into a shared UI package in Turborepo, Nx, or pnpm workspaces.

The CLI creates the target directory if it doesn't exist.

Shared Monorepo Installation

# Scaffold inside shared packages/ui directory

$pnpm dlx glidecn-cli init --path packages/ui/src/components/glidecn

← Quickstart / Install API Reference Hub →