Creation.md

Creating from the Terminal

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

npx create-typescript-app

The creation script will by default:

1. Create a new directory with the given repository name
2. Initialize that 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 explicitly provide some or all of the options the script would prompt for as command-line flags. See Options.md.

For example, running the creation script and skipping all GitHub-related APIs:

npx create-typescript-app --mode create --skip-all-contributors-api --skip-github-api

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