Creation.md

Creating from the Terminal

You can run npx create typescript-app@beta in your terminal to interactively create a new repository:

npx create typescript-app@beta

The creation script will by default:

1. Prompt you for a directory, which template preset to run with, and some starting information
2. Initialize new directory as a local Git repository
3. Copy the template's files to that directory
4. Create a new repository on GitHub and set it as the local repository's upstream
5. Configure relevant settings on the GitHub repository

You'll then need to manually go through the following two steps to set up tooling on GitHub:

1. Create two tokens in repository secrets (unless you chose to opt out of releases):
   • ACCESS_TOKEN: A GitHub PAT with repo and workflow permissions
   • NPM_TOKEN: An npm access token with Automation permissions
2. Install two GitHub apps:
   • Codecov (unless you chose to opt out of tests)
   • Renovate (unless you chose to opt out of renovate)

Your new repository will then be ready for development! Hooray! 🥳

Options

You can customize which pieces of tooling are provided and the options they're created with. See Options.md.

For example, skipping the "This package was templated with..." block:

npx create typescript-app@beta --mode create --exclude-templated-with

See Blocks.md for details on the tooling pieces and which presets they're included in.