Skip to content

A CLI tool to quickly scaffold a TypeScript project with tsx support, providing an easy and efficient development setup.

Notifications You must be signed in to change notification settings

mattiamalonni/create-tsx-app

Repository files navigation

create-tsx-app

A CLI tool that quickly scaffolds a new TypeScript project with tsx pre-configured. It sets up a clean and minimal project structure, allowing you to start coding immediately.

Features

Interactive prompts for project setup
Customizable project name and package.json
Automatically installs dependencies (tsx, typescript)
Option to overwrite existing directories
Minimal boilerplate with a ready-to-run TypeScript setup

Usage

Basic Usage

npx create-tsx-app@latest my-app

This will:

  • Ask for a project name (my-app by default)
  • Check if the directory is empty
  • Prompt to overwrite or keep existing files if necessary
  • Generate a minimal TypeScript project
  • Ask if you want to install dependencies

Command-Line Options

Option Alias Description
--install -i Automatically install dependencies (npm install)
--overwrite -o Overwrite an existing directory without asking

Example Usage with Flags

npx create-tsx-app my-app -- --install

This will create the project and install dependencies automatically.

npx create-tsx-app my-app -- --overwrite

This will remove existing files in my-app and proceed with the setup.

Project Structure

After running the command, your project will have the following structure:

my-app/
├── src/                # Your source code directory
│   ├── index.ts        # Entry point
├── tsconfig.json       # TypeScript configuration
├── package.json        # Project metadata and dependencies
├── .gitignore          # Git ignore file
└── README.md           # Project documentation

Happy coding! 🎉

About

A CLI tool to quickly scaffold a TypeScript project with tsx support, providing an easy and efficient development setup.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •