Skip to main content

CLI Overview

Skelion includes a CLI tool for quick project setup and component generation.

Commands

CommandDescription
npx skelion initInitialize Skelion in your project
npx skelion generate <template>Generate a skeleton component
npx skelion --helpShow help
npx skelion --versionShow version

Quick Start

# Set up Skelion in your project
npx skelion init

# Generate a card skeleton component
npx skelion generate card

# Generate with custom name and animation
npx skelion generate profile --name User --animation shimmer

Configuration

The init command creates a skelion.config.ts file in your project root:

skelion.config.ts
import type { SkelionConfig } from "skelion";

const config: SkelionConfig = {
animation: "pulse",
density: "medium",
duration: 1.5,
};

export default config;

The generate command reads this configuration to set default values for generated components.