CLI.md

CLI

create-typescript-app supports all the flags supported by Bingo CLIs. It also provides a collection of custom flags per Bingo CLI > Template Flags.

npx create-typescript-app

Required Flags

These options can only be inferred when running on an existing repository. Each will be prompted for when creating a new repository if not explicitly provided:

Flag	Description
--description	'Sentence case.' description of the repository
--directory	which directory and repository name to use
--preset	starting set of tooling to use

npx create-typescript-app provides three --preset options:

1. Minimal: Just bare starter tooling: building, formatting, linting, and type checking.
2. Common: Bare starters plus testing and automation for all-contributors and releases.
3. Everything: The most comprehensive tooling imaginable: sorting, spellchecking, and more!

For example, to create a new repository with the Everything preset and prompt for description and directory:

npx create-typescript-app --preset everything

Pre-populating all required base options:

npx create-typescript-app --directory my-app --description "My app! 💖" --preset everything

See Bingo > Stratum > Concepts > Templates > --preset for more details on presets.

Optional Flags

The following flags may be provided on the CLI to customize their values. Each defaults to a value based on the running system, including an repository if transitioning one.

Flag	Type	Description	Default
--access	string	Which npm publish --access to release npm packages with	"public"
--author	string	Username on npm to publish packages under	An existing npm author, or the currently logged in npm user, or owner.toLowerCase()
--bin	string	Value to set in package.json's "bin" property, per FAQs > How can I use bin?	(none)
--email	string	Email address to be listed as the point of contact in docs and packages (e.g. [email protected])	Yours from gh, git config, or npm whoami
--emoji	string	decorative emoji to use in descriptions and docs	The last emoji from description, or "💖"
--funding	string	GitHub organization or username to mention in funding.yml	The same as owner
--keywords	string[]	Any number of keywords to include in package.json	(none)
--owner	string	Organization or user owning the repository	Yours from gh or git config
--pnpm	string	pnpm version for package.json's packageManager field	Existing value in package.json if it exists
--repository	string	Name for the new repository	The same as --directory
--title	string	'Title Case' title for the repository	Title-cased repository
--version	string	package version to publish as and store in package.json	Existing value in package.json if it exists, or "0.0.0"

For example, customizing the npm author and funding source to different values than what would be inferred:

npx create-typescript-app --author my-npm-username --funding MyGitHubOrganization

Array flags can be specified as space-delineated strings and/or multiple times. For example, customizing keywords to three:

npx create-typescript-app --keywords eslint --keywords "javascript typescript"

Block Exclusion Flags

Per Bingo > Stratum > Concepts > Templates > Exclusion Options, individual "Blocks" of tooling may be excluded from running. Each Block may be excluded with a CLI flag whose name matches --exclude-*.

For example, initializing with all tooling except for Renovate:

npx create-typescript-app --exclude-renovate

See Blocks.md for the list of blocks, which presets contain them, and their corresponding --exclude-* flags.