@dscodotco/theme-cli
Version:
A CLI tool for developing Shopify themes
28 lines (27 loc) • 815 B
TypeScript
/**
* @module commands/shopify/theme/init
* @description Commands for initializing Shopify themes
*/
import { ThemeInitOptions } from "../../../types/index.js";
/**
* Initializes a new Shopify theme by downloading and extracting the Dawn theme
*
* @param options - Configuration options for initializing the theme
* @returns A promise that resolves when the theme is initialized
*
* @example
* ```typescript
* // Initialize a theme with default options
* await initShopifyTheme();
*
* // Initialize a theme with custom options
* await initShopifyTheme({
* name: 'my-store-theme',
* outputDir: './projects',
* force: true
* });
* ```
*
* @throws Will throw an error if the theme initialization fails
*/
export declare function initShopifyTheme(options: ThemeInitOptions): Promise<void>;