Skip to content

api.md

Latest commit

 

History

History
45 lines (32 loc) · 953 Bytes

api.md

File metadata and controls

45 lines (32 loc) · 953 Bytes
Raw

API Reference

This document outlines the programmatic interfaces available within ForgeTS.

CLI Command Reference

The primary API is the Command Line Interface.

forgets new

Creates a new project from a template.

Usage:

forgets new <name> [options]

Options:

  • --template <id>: Specify the template to use (e.g., react-vite).
  • --skip-install: Do not install dependencies after generation.
  • --dry-run: Preview files to be generated.

forgets help

Display help information for any command.

Usage:

forgets help [command]

Internal Library API

Note: This API is currently internal to the monorepo and subject to change.

CoreGenerator

The core class responsible for scaffolding.

import { CoreGenerator } from '@forge-ts/core';

const generator = new CoreGenerator({
  templateDir: './templates/react',
  targetDir: './my-app'
});

await generator.run();