X Tutup
Skip to content

Latest commit

 

History

History

README.md

@forge-ts/cli

Production-grade project scaffolding for TypeScript, optimized for AI agents and human engineers.

ForgeTS provides a deterministic, secure, and best-practice baseline for new projects. It enforces strict quality gates (no any, strict linting) and generates AI-readable metadata (AGENTS.md) by default.

Installation

npm install -g @forge-ts/cli
# or
pnpm add -g @forge-ts/cli

Usage

Interactive Mode

Simply run the command and follow the prompts:

forgets init

Configuration Mode

Pass a JSON or YAML configuration file for reproducible scaffolding:

forgets init --config project.json

Example project.json:

{
  "project": {
    "name": "my-app",
    "type": "react-vite",
    "language": "typescript",
    "git": true,
    "docker": true
  }
}

Supported Templates

Template Description Stack
ts-backend Strict Node.js Service Node 20+, TypeScript (Strict), Zod, Vitest
react-vite Modern Frontend App React, Vite, Redux Toolkit, MUI, Tailwind

Features

  • Strict by Default: noImplicitAny, strict ESLint rules, and Prettier integration out of the box.
  • AI-First: Generates AGENTS.md and CONVENTIONS.md to help AI agents understand your codebase immediately.
  • Global Options:
    • Git: Auto-init and initial commit.
    • Docker: Multi-stage Dockerfile and docker-compose.yml.

License

MIT

X Tutup